docs: update KubeEnforcer docs to be consistent with others #108
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
- have an Aqua image at the top - say "Aqua Security" for heading, not just "Aqua" - have a one-line description of the Chart - use a "Contents" section - not just "Contents:" text - and link to it in ToC - use a "Configurable Variables" section - not a "Customize your configuration section" - not an H3, but an H2 - and add a "KubeEnforcer" subsection - and add links to both in ToC - all the other charts already do this, KubeEnforcer was the odd one out
This was referenced Jul 28, 2020
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
have an Aqua image at the top
say "Aqua Security" for heading, not just "Aqua"
have a one-line description of the Chart
use a "Contents" section
use a "Configurable Variables" section
all the other charts already do this, KubeEnforcer was the odd one out
Tags
Related to #106 and #105 in adding consistency. The differences in consistency tripped me up when writing #99 as well.
Fixes inconsistencies introduced in #86