docs: add numbering to headers to help navigation and readability #639
Conversation
This file contains 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
maleck13
reviewed
May 13, 2024
| @@ -1,43 +1,45 @@ | |||
| # Secure, protect, and connect APIs with Kuadrant | |||
| # Secure, protect, and connect APIs with Kuadrant on OpenShift | |||
There was a problem hiding this comment.
hmm this is making me think. The only OpenShift specific things here is the reference to the install. Could probably update this to also suggest the quick starts that install kind clusters. Would be nice to have this guide as the "one to rule them all"
There was a problem hiding this comment.
I will create a follow up for that #640
There was a problem hiding this comment.
Thanks @maleck13 Yes, agree that a single generic guide would be best and easier to maintain.
We currently have two guides with the same heading name. This PR updates both heading names to distinguish between OpenShift and Kubernetes for now, which matches the approach taken in the site TOC.
maleck13
reviewed
May 13, 2024
maleck13
approved these changes
May 13, 2024
Co-authored-by: Craig Brookes <maleck13@users.noreply.github.com>
|
Thanks @maleck13 Can you merge this one also? I don't have write access to Merge button :) |
maleck13
added a commit
that referenced
this pull request
May 13, 2024
* docs: add numbering to headers to help navigation and readability, minor edits * docs: add line break to fix bullet list format on kuadrant docs site * Update doc/user-guides/secure-protect-connect-single-multi-cluster.md Co-authored-by: Craig Brookes <maleck13@users.noreply.github.com> --------- Co-authored-by: Craig Brookes <maleck13@users.noreply.github.com>
maleck13
added a commit
that referenced
this pull request
May 13, 2024
* docs: add numbering to headers to help navigation and readability, minor edits * docs: add line break to fix bullet list format on kuadrant docs site * Update doc/user-guides/secure-protect-connect-single-multi-cluster.md Co-authored-by: Craig Brookes <maleck13@users.noreply.github.com> --------- Co-authored-by: Craig Brookes <maleck13@users.noreply.github.com>
maleck13
added a commit
that referenced
this pull request
May 13, 2024
* docs: add numbering to headers to help navigation and readability, minor edits * docs: add line break to fix bullet list format on kuadrant docs site * Update doc/user-guides/secure-protect-connect-single-multi-cluster.md Co-authored-by: Craig Brookes <maleck13@users.noreply.github.com> --------- Co-authored-by: Craig Brookes <maleck13@users.noreply.github.com>
maleck13
added a commit
that referenced
this pull request
May 13, 2024
…dability (#639) (#642) * docs: add numbering to headers to help navigation and readability (#639) * docs: add numbering to headers to help navigation and readability, minor edits * docs: add line break to fix bullet list format on kuadrant docs site * Update doc/user-guides/secure-protect-connect-single-multi-cluster.md Co-authored-by: Craig Brookes <maleck13@users.noreply.github.com> --------- Co-authored-by: Craig Brookes <maleck13@users.noreply.github.com> * add latest catalog version --------- Co-authored-by: Stephen McCarthy <29098561+smccarthy-ie@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Mainly adding numbered headings to help keep track of where you are in procedures, and minor copy edits only. No changes to technical content.
Please cherry pick to v0.7 also. Thanks