Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Double Dash in Annotations #56

Merged
merged 2 commits into from
Jun 1, 2018
Merged

Remove Double Dash in Annotations #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96c7fb4
remove double dash. prevented auto xlst from creating documentation
nllong Jun 1, 2018
0de0073
update release doc
nllong Jun 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions BuildingSync.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3195,22 +3195,22 @@
</xs:element>
<xs:element name="ApplicableStartDateForEnergyRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date from which the rate is applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date from which the rate is applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ApplicableEndDateForEnergyRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date after which the rate is not applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date after which the rate is not applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ApplicableStartDateForDemandRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date from which the rate is applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date from which the rate is applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ApplicableEndDateForDemandRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date after which the rate is not applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date after which the rate is not applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DemandWindow" minOccurs="0">
Expand Down Expand Up @@ -3319,22 +3319,22 @@
</xs:element>
<xs:element name="ApplicableStartDateForEnergyRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date from which the rate is applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date from which the rate is applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ApplicableEndDateForEnergyRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date after which the rate is not applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date after which the rate is not applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ApplicableStartDateForDemandRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date from which the rate is applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date from which the rate is applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ApplicableEndDateForDemandRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date after which the rate is not applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date after which the rate is not applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TimeOfUsePeriod" minOccurs="0" maxOccurs="unbounded">
Expand Down Expand Up @@ -3474,12 +3474,12 @@
</xs:element>
<xs:element name="ApplicableStartDateForEnergyRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date from which the rate is applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date from which the rate is applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ApplicableEndDateForEnergyRate" type="xs:gMonthDay" minOccurs="0">
<xs:annotation>
<xs:documentation>The date after which the rate is not applicable. (--MM-DD)</xs:documentation>
<xs:documentation>The date after which the rate is not applicable. (MM-DD)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RateTier" minOccurs="0" maxOccurs="unbounded">
Expand Down
34 changes: 25 additions & 9 deletions docs/release_instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
# Releasing

When releasing new versions, make sure to do the following:
Follow the steps below when releasing a new version

* Update the Version in the header of the XSD with the release date
(e.g. Version 0.2 (November 5, 2017))
* (Optional) Convert XSD to JSON schema. This is still in prototype.
* Update the Changelog to include the latest changes, and the most
recent version. Easiest to run the change_log.rb script (e.g. ruby src/change_log.rb -t abcdefghijklmnopqrstuvwxyz -s <last-release-data>).
* After merging down the release into the main branch, draft a release in Github. Upload the XSD and JSON file as part of the release.
* Copy the schema to the website-schemas repo with documentation. Note that this is not what we really want to do anymore. (website-schema repo here: https://github.com/BuildingSync/website-schemas)
* Add links ot the index.md in the root of website-schemas repo
* In the website repo update the docs/schema/index.md to include the
new release.

* (Optional) Convert XSD to JSON schema. This is still in prototype. Use XMLSpy to Generate JSON Schema (use default options).

* Ensure that the XSD and JSON Schema have spaces, and not tabs.

* Update the CHANGELOG to include the latest changes, and the most recent version.

* Run the change_log.rb script (e.g. ruby src/change_log.rb -t abcdefghijklmnopqrstuvwxyz -s <last-release-data>).
* Copy the results of this into the CHANGELOG. Remove items that are not useful to an end user such as version bumps, formatting, etc.

* After merging down the release into the main branch, draft a release in GitHub. Upload the XSD and JSON file as part of the release.

* Use xs3p to generate the documentation. .

* Download [V1.1.5](https://sourceforge.net/projects/xs3p/) and unzip.
* Run `xsltproc xs3p.xsl <path-to-BuildingSync.xsd> > index.html` to generate the new html documentation. Note that xsltproc may need to be installed on your machine to run.

* Edit the BuildingSync Website GitHub repo on a new branch (https://github.com/BuildingSync/website):

* Add generated documentation under /documents/schema/documentation/<new_version>
* Update /documents/schema/index.md to include new release, follow existing pattern.

* Create a Pull Request from the new branch to gh-pages.