-
-
Notifications
You must be signed in to change notification settings - Fork 489
Update release procedure documentation #1414
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.
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
Merged
Merged
Conversation
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
Previously, the procedure for creating a new release of the project was included in the development documentation. This information is distinct from the rest of the contents of that file in that it is not of any value or interest to most contributors from the community since only project maintainers will ever create a release. This meant that it make the document less readable and approachable without adding significant value in return. The information is still essential to the project maintainers, so it must not be removed, but it can be moved to a dedicated file under the existing `docs/internal/` folder that is specifically intended for storing such information.
@per1234
per1234
added
topic: documentation
Related to documentation for the project
type: enhancement
Proposed improvement
labels
Sep 8, 2022
kittaakos
kittaakos
approved these changes
Sep 8, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
AlbyIanna
AlbyIanna
approved these changes
Sep 8, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Thanks @per1234 for taking care of this ❤️
An internal release procedure document was created separately from the documentation hosted in this repository. That internal document became significantly more comprehensive and up to date than the unmaintained documentation in this repository. In order to avoid either the burden of maintaining two copies of the same information, or more likely the out of sync state between the information in the two resulting from lack of such maintenance, a single document will be maintained here in this repository. The superior version of the information from the internal document is hereby migrated to the repository where it will be maintained from here on.
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
An internal release procedure document was created separately from the documentation hosted in this repository. That internal document became significantly more comprehensive and up to date than the unmaintained documentation in this repository.
The current situation results either in the burden of maintaining two copies of the same information, or more likely the out of sync state between the information in the two resulting from lack of such maintenance.
Change description
A single document will be maintained here in this repository from now on. The superior version of the information from the internal document is migrated to the repository.
Other information
The documentation is moved from the previous inappropriate location in
BUILDING.md
to a dedicated filedocs/internal/release-procedure.md
Supersedes the alternative proposal at #1408
Reviewer checklist