Add a 1-sentence-summary for each component and components repository in the catalog
Overview
Related note from the research - https://gitlab.com/gitlab-org/gitlab/-/issues/399504
We could provide a summary for easier navigation of the component repository in the catalog.
- Research insights:
- When trying to find a CI Template, users were clicking in and out of the individual templates in search of a one line summary of what each template did and what it should be used for. This wasted time and lead to lower customer efforts scores. Users were unsure what each template did when looking at the overview page.
- When trying to find a CI Template, users were clicking in and out of the individual templates ReadMe files in search of a one line summary of what each template did and what it should be used for. This wasted time and lead to lower customer efforts scores.
Proposal
- Iteration 1: Completed
✅ - Design issue: #392738 (closed)
- Check out implementation on
.com
: https://gitlab.com/gitlab-org/gitlab/-/ci/catalog/resources/27 - Have a 1-sentence summary for the components repository level. (above the tab area)
- Iteration 2: Design is done
✅ - Design issue: #415657 (closed)
- We include guidance in the documentation for users to have a 1-sentence summary for each component in the readme file. (below the tab area) And we could explain why a description is mandatory when creating a catalog resource repository.
- For beta, it is recommended #415657[Details-inputs-table-v2.png]
Next iterations (GA)
We could utilize the manifest file to let users provide the description per component as well.
This will show up in the Components
tab once users put the description.
Edited by Sunjung Park