docs: consistently use "Issues and feedback" section #106
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
- kube enforcer uses an "Issues and feedback" section and no
"Support" section
- I think this section is clearer than "Support"; I assume a "Support"
section may link to a customer service email or ticketing system,
not to standard GitHub issues
- enforcer had both an "Issues and feedback" section _and_ a "Support"
section
- remove the duplicative "Support" section
- server had a "Support" section but wasn't linked in ToC
- add "Issues and feedback" and link in ToC
- scanner had a "Support" section
- change to "Issues and feedback"
- main repo root README had a "Support" section
- change to "Issues and feedback"
- also fix heading to be an H2 as only one H1 is semantically allowed
per page
- and all other docs use an H2 for this section
agilgur5
force-pushed
the
docs-consistent-issues-and-feedback
branch
from
2bada8a
to
9e56ae4
Compare
- only Enforcer had plural "Charts", but it is only a single chart
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.
Description
"Support" section
section may link to a customer service email or ticketing system,
not to standard GitHub issues
section
per page
Tags
Related to #105 and #108 , just a lot of consistency issues in general. In this case, unlike #105, they're not harmful and have low impact, but generally good to be consistent anyway.