-
Notifications
You must be signed in to change notification settings - Fork 376
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
🌱 minor docs improvements #2866
Conversation
ncdc
commented
Mar 3, 2023
- Fix file names so they more closely match the h1 headings. This makes the leftnav sort alphabetically.
- Move the concepts index page to terminology.md. Switch the index to a section overview page.
- Add missing descriptions from a couple of the pages and fix punctuation for consistency.
/hold |
Make sure file names more closely match their h1 heading at the top of each document, as mkdocs sorts the leftnav by file name, not by h1 heading. Signed-off-by: Andy Goldstein <andy.goldstein@redhat.com>
Move the terminology content from concepts/index.md to concepts/terminology.md, so it is a standalone page. Make concepts/index .md a section overview page. Signed-off-by: Andy Goldstein <andy.goldstein@redhat.com>
Signed-off-by: Andy Goldstein <andy.goldstein@redhat.com>
Signed-off-by: Andy Goldstein <andy.goldstein@redhat.com>
Signed-off-by: Andy Goldstein <andy.goldstein@redhat.com>
/approve |
/hold |
/unhold |
kcp-dev/contrib-tmc#93 |
Signed-off-by: Andy Goldstein <andy.goldstein@redhat.com>
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ncdc, nrb The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |