Document release process#14622
Merged
Merged
Conversation
…ttX release process, copied from Alin Jerpelea's gist documentation.
github-actions
Bot
added
Area: Documentation
1 task
xiaoxiang781216
approved these changes
Nov 4, 2024
Contributor
|
@lupyuen please reopen the issue, if you want to add more info. |
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
2 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.
Summary
This PR adds a documentation page under the "Contributing" section of the NuttX docs which contains the NuttX release process documentation from Alin Jerpelea's gist: https://gist.github.com/jerpelea/67895da8797f040ba3b113280fdcd57b
Impact
This contributes a step forward towards the issues discussed in #14062. The release process is now documented centrally on the NuttX website and can be modified there as a single source of information for new contributors to see how releases are made.
There is still more information which could be added, like the information in Lup's comment on #14062, but I am opening this PR to get the documentation which already exists in a consolidated form included on the website.
Testing
I performed a local build of the documentation, ensured there were no errors and visually inspected the rendered HTML in my browser to make sure that the formatting was okay.