Surface subcomponent READMEs in the Components Catalog
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Proposal
A customer reached out to me about their experience with the CI/CD component catalog. Given that you can place more than one component in a component project, the documentation seems to encourage users to group related components together. Each component can have its own README to provide component-specific documentation.
For example, a customer configuration includes a "Maven Components" project, inside of which are CI components for "maven-test", "maven-build", "maven-publish". The README.md at the project level includes general documentation on using the components but they have a README for each individual component that provides more detailed information on behavior. I would expect this to be a common pattern.
The problem is that the component catalog does not display the READMEs of individual components, or provide an easy way to get to them. It seems that the intended solution might be for customers to link from the project README to the individual component READMEs, but that introduces a DRY/maintenance issue on having to update the project README whenever a component is added/removed. It's also not very user friendly, in that it's not all that obvious how to do so---at least adding to the documentation might help smooth this out.
See related issue that complicates linking users to documentation: #514019 And related issue about improving how we surface component documentation in general: #509097