Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃尡 minor docs improvements #2866

Merged
merged 6 commits into from
Mar 3, 2023
Merged

Conversation

ncdc
Copy link
Member

@ncdc 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.

@ncdc
Copy link
Member Author

ncdc commented Mar 3, 2023

/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 3, 2023
ncdc added 5 commits March 3, 2023 13:28
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 <[email protected]>
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 <[email protected]>
Signed-off-by: Andy Goldstein <[email protected]>
Signed-off-by: Andy Goldstein <[email protected]>
@ncdc
Copy link
Member Author

ncdc commented Mar 3, 2023

/approve
/unhold

@openshift-ci openshift-ci bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Mar 3, 2023
@ncdc
Copy link
Member Author

ncdc commented Mar 3, 2023

/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 3, 2023
@ncdc
Copy link
Member Author

ncdc commented Mar 3, 2023

/unhold

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 3, 2023
@ncdc
Copy link
Member Author

ncdc commented Mar 3, 2023

kcp-dev/contrib-tmc#93
/retest

Signed-off-by: Andy Goldstein <[email protected]>
@nrb
Copy link
Contributor

nrb commented Mar 3, 2023

/lgtm
/approve

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 3, 2023
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Mar 3, 2023

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit e1353f4 into kcp-dev:main Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants