Deprecate documentation template - delete Camara_Versioning_Guidelines.md#261
Merged
shilpa-padgaonkar merged 2 commits intocamaraproject:mainfrom Aug 2, 2024
Merged
Conversation
Contributor
|
As our 3rd codeowner @patrice-conil is on vacation, will merge this PR with 2 approvals. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
In order to reduce redundancy, all documentation should be embedded within the OAS definition.
The API-DocumentationTemplate.md file is deprecated.
The Camara_Versioning_Guidelines.md was removed in #215 but was restored with zero length with #234.
It is deleted here.
Which issue(s) this PR fixes:
Fixes #260
Special notes for reviewers:
The old issue with decision of Commonalities
camaraproject/WorkingGroups#164
Potentially more detailed guidelines can be created for description field in
infoobject as main documentation location, and for documenting error cases, etc.Changelog input