Add docs for each chart and docs generation/linting #150
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
|
🤖 Created branch: z_pr150/dfarrell07/helm-docs2 |
|
I sent a PR upstream to fix the markdownlint failure on raw URLs in the maintainers table: norwoodj/helm-docs#102 |
33 tasks
Somehow the GitHub Pages URL we use to publish and install the charts works to install the charts in CI but also fails with a 404 in CI. The URL is successfully used by Shipyard here: https://github.com/submariner-io/shipyard/blob/ 33dc2ffdadf6e520a2101368f7f7456c031bace0/scripts/shared/lib/ deploy_helm#L14 Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
The maintainers table generated by helm-docs includes a raw URL in Markdown, which fails markdownlint. I sent a PR upstream to fix the root of the issue, but for now we have to disable this linter rule. Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
Add docs generated by helm-docs for each chart. The docs will be kept up-to-date with CI and the contents of the docs can be improved in future changes to inline commenting. Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
Generate docs for each chart and verify the committed docs match the generated docs. Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
For now there's a commit in this PR to ignore the markdownlint raw URL rule. And if anyone has an explanation for the GH Pages URL working to release/install charts but resolving 404, I'd love to include it in the commit message to ignore that URL in markdownlinkcheck: b9a3f84 |
tpantelis
approved these changes
Jun 28, 2021
skitt
approved these changes
Jun 29, 2021
|
Sent #153 to fix the bot not adding /ready-to-test. |
|
🤖 Closed branches: [z_pr150/dfarrell07/helm-docs2] |
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.
See commit messages for details:
Closes: #69