Skip to content
New issue

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

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

Already on GitHub? # to your account

docs(schema): add deprecation policy #261

Merged
merged 5 commits into from
Nov 4, 2020
Merged

Conversation

markborkum
Copy link
Contributor

No description provided.

Copy link
Contributor

@macintoshpie macintoshpie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great 👍

@corymosiman12
Copy link
Contributor

Putting it in the schema seems fine but can we also add it to developer docs?

Copy link
Contributor

@corymosiman12 corymosiman12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also add to developer docs

@markborkum
Copy link
Contributor Author

Putting it in the schema seems fine but can we also add it to developer docs?

I'd prefer not. If the deprecation policy is an intrinsic part of schema file, then it is exchanged with the schema file and it travels with the schema file, wherever it goes. Having an alternate representation of the deprecation policy in the docs/ folder is disadvantageous because it would force us to either maintain a duplicate the same content or to maintain a URL, which must be resolvable, within the schema file to a "raw" file (e.g., in the GitHub repository).

@corymosiman12
Copy link
Contributor

Sure I mean maybe we just make a note in the developer docs that the deprecation policy is defined by the schema doc. My point is most people look to documentation on Github. It wouldn't be intuitive to me that the deprecation policy is defined in the Schema itself.

Copy link
Contributor

@corymosiman12 corymosiman12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌭

Copy link
Member

@nllong nllong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great.


## Deprecation Policy

Details of the deprecation policy are included in the BuildingSync XML schema file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@nllong nllong merged commit 5cd4195 into develop Nov 4, 2020
@nllong nllong deleted the docs/deprecation-policy branch November 4, 2020 23:51
@nllong nllong added the Schema: Documentation Update to BuildingSync's documentation/annotations label Dec 17, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Non-breaking Change Schema: Documentation Update to BuildingSync's documentation/annotations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants