docs: add Autoware Index documentation#806
Open
xmfcx wants to merge 3 commits into
Open
Conversation
Add an installation page describing the Autoware Index: how to compose repositories/autoware-index.repos with aw-index-cli or the browse site, import it with vcs import, check the workspace against the registry, and register community packages. Cross-reference it from the source installation page and the repos-files design page. Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
|
Thank you for contributing to the Autoware project! 🚧 If your pull request is in progress, switch it to draft mode. Please ensure:
|
xmfcx
added
the
tag:deploy-docs
Surface the Autoware Index page from high-traffic entry points: a section with a button on the installation landing page, a button on the homepage, and a dedicated optional workspace-setup step in both the source and Docker installation guides. Make the nav title self-describing, and turn the page itself into a hub with browse/register buttons and a screenshot of the browse site. Clarify the tag filter semantics on the way. Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
Mark the page with the Material status front matter and restyle the status marker into the same animated NEW pill used on the homepage. Reuse the pill on the community-packages step in the source and Docker installation guides. Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
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
1 participant
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.
Description
Adds documentation for the Autoware Index, the registry of community ROS 2 packages that extend Autoware.
docs/installation/autoware/autoware-index.md(new): what the Index is, composingrepositories/autoware-index.reposwithaw-index-clior the browse site's Repos builder, importing it withvcs import, thecheckandlistsubcommands, and how to register community packages. Includes Browse/Register buttons and a screenshot of the browse site.Discoverability
The page is surfaced from the high-traffic entry points:
docs/home/index.md): a featured primary button with a "NEW" badge (badge styles indocs/assets/css/extra.css, with aprefers-reduced-motionguard).docs/installation/index.md): an "Extending Autoware with community packages" section with a button.docs/design/repos-files.md): a grid card forautoware-index.repos, noting it is generated and not tracked by git.docs/installation/autoware/.pages.Merge order
repositories/autoware-index.reposto.gitignore. Merge that first, since this page states the generated file is ignored by git.