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
Rearrange documentation and add additional content #1279
Conversation
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
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.
cc @munnerz
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.
cc @munnerz
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
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
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: munnerz, rimusz The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Not in the PR but theres a typo in this section: https://cert-manager-munnerz.readthedocs.io/en/revamp-docs/tasks/issuers/setup-vault.html#vault-authentication-with-a-approle The sentence "... parameter as no effect ..." should be "... parameter has no effect ...". "... many authentication backend supported by Vault." should be "backends". This sections has some issues "For testing purpose a root token which do not expire is generated at Vault installation time. WARNING: a root token should only be used for testing purpose only." I'd advise something like: "For testing purposes a root token is generated at Vault installation time. WARNING: Root tokens do not expire, so should only be used for testing purposes." |
It might be worth adding a note to the upgrading page about backing up first with a link to the relevant page. |
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
After discussion on the community call yesterday, we're going to cherry pick these docs changes into the v0.6 branch as they contain a fair bit of extra useful information 😄 |
/milestone v0.6 |
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Signed-off-by: James Munnelly <james@munnelly.eu>
Going to merge this now as it is a net-improvement to the docs in its current state. I'll follow up with additional PRs if anyone has any other comments, and to fill in/rewrite some areas that need it 😄 |
…release-0.6 Automated cherry pick of #1279
What this PR does / why we need it:
This PR does a few things:
tasks/
sectionWhich issue this PR fixes fixes #1151, fixes #1269
Special notes for your reviewer:
I've setup readthedocs on my fork of cert-manager, and you can view a sample of these new docs here: https://cert-manager-munnerz.readthedocs.io/en/revamp-docs/index.html
Release note:
/cc @heckj @DanielMorsing