-
Notifications
You must be signed in to change notification settings - Fork 9.2k
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
[bitnami/*] Standardize documentation #19835
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the changes, in general, they LGTM. Just a comment that could be applied to the rest of sections
Please apply the comments related to placeholders for consistency with the rest of documentation. Thank you! |
ce20903
to
be0b86b
Compare
Waiting for bitnami/readme-generator-for-helm#78 before updating all README files in this PR. |
21f4fe9
to
e32eb0a
Compare
78f1825
to
f46027f
Compare
README.md
Outdated
``` | ||
|
||
> Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
Changes LGTM overall, just I would add the placeholders as a text field (see above example) or at least in italics, but differentiate from regular text in some way. WDYT @raquel-campuzano?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This info looks better this way. I just applied the changes.
0e9e325
to
7d733db
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Jota Martos <jotamartos@vmware.com>
2bf774a
to
0bb71e5
Compare
Signed-off-by: Jota Martos <jotamartos@vmware.com>
Signed-off-by: Jota Martos <jotamartos@vmware.com>
Description of the change
Standardize documentation for all charts in the catalog
Benefits
Documentation can be reused in all projects. It's not dependent of the distro or repository information.
Possible drawbacks
Applicable issues
Additional information
Checklist
Chart.yaml
according to semver. This is not necessary when the changes only affect README.md files.README.md
using readme-generator-for-helm