Rename Package maintainer guide to Core maintainer guide. (backport #4619) #4643
Conversation
This file contains 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
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
* Use package and repository appropriately in context. ROS 2 source repositories may consist of multiple packages and certain operations are per-repository rather than per-package. I've gone through and updated the documentation to use "package" or "repository" when correct in context. In a couple of cases, I removed the specification entirely (particularly in front of the word "maintainer"). * Rename "Package maintainer guide" to "Core maintainer guide". This rename is motivated by a desire to begin a manual / guide for maintainers of _community_ packages in ROS 2 distributions. The current title is overly broad, as the guide content is targeted at ROS 2 core package maintainers rather than a maintainer of any package released in ROS 2. Renaming and redirecting articles has a cost and I know this rename isn't free. But I think it's justified in order to provide space for content aimed at community maintainers. * Move renamed guide. (cherry picked from commit 2f80c3f)
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/10478523573/artifacts/1834354169. To view the resulting site:
|
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.
This rename is motivated by a desire to begin a manual / guide for maintainers of community packages in ROS 2 distributions.
The current title is overly broad, as the guide content is targeted at ROS 2 core package maintainers rather than a maintainer of any package released in ROS 2.
Renaming and redirecting articles has a cost and I know this rename isn't free. But I think it's justified in order to provide space for content aimed at community maintainers.
There's an additional commit on here of edits I made to the doc while squaring it up with its new title. Even if we don't take the rename some of those edits are worth keeping in a dedicated PR.
Most of the changes there are clarifying whether an operation is per-repository or per-package. I've gone through and updated the documentation to use "package" or "repository" when correct in context. In a couple of cases, I removed the specification entirely (particularly in front of the word "maintainer").
This is an automatic backport of pull request #4619 done by Mergify.