Skip to content

Update renewal docs#570

Merged
jetstack-bot merged 4 commits intocert-manager:release-nextfrom
irbekrm:update_renewal_docs
Jun 3, 2021
Merged

Update renewal docs#570
jetstack-bot merged 4 commits intocert-manager:release-nextfrom
irbekrm:update_renewal_docs

Conversation

@irbekrm
Copy link
Contributor

@irbekrm irbekrm commented May 24, 2021 •
edited
Loading

In cert-mananger/#4040 we changed how the renewal time of a cert is calculated.

This PR updates the docs and tries to explain the renewal time/duration/renewBefore in a bit more detail.

This PR is against release-next branch as it adds v1.4 specific documentation. Once v1.4 is released, we should also merge this into master.

Fixes #567

@jetstack-bot jetstack-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 24, 2021
@irbekrm irbekrm force-pushed the update_renewal_docs branch from 0b1727b to ff1dd2b Compare May 24, 2021 16:26
@irbekrm irbekrm mentioned this pull request May 25, 2021
Merged
wallrj
wallrj approved these changes May 26, 2021
View reviewed changes
Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you create the PR against the release-next branch, it will not show up in the live docs when merged, but instead it will be visible only when you visit: https://cert-manager.io/next-docs/

That way we can preview how the documentation is coming together before we do the 1.4 release.

Also, create a https://github.com/cert-manager/website/tree/master/content/en/docs/release-notes/release-1.4.md file and add a paragraph there about the slight change in behaviour.

@jetstack-bot jetstack-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 28, 2021
@irbekrm irbekrm force-pushed the update_renewal_docs branch from ff1dd2b to 01523d0 Compare May 28, 2021 09:17
@jetstack-bot jetstack-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 28, 2021
@irbekrm irbekrm changed the base branch from master to release-next May 28, 2021 09:18
@jetstack-bot jetstack-bot added do-not-merge/cherry-pick-not-approved Indicates that a PR is not yet approved to merge into a release branch. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 28, 2021
@irbekrm
Copy link
Contributor Author

irbekrm commented May 28, 2021

Thanks @wallrj ! I've added https://github.com/cert-manager/website/tree/master/content/en/docs/release-notes/release-1.4.md file.
I guess we first need to merge all the current diff from master into release-next?

irbekrm added 4 commits June 1, 2021 15:41
@irbekrm
Add a section about Certificate's renewal time calculation
43071ff 
Signed-off-by: irbekrm <irbekrm@gmail.com>
@irbekrm
Remove obsolete comment
dd5c666 
Since renewBefore is now calculated as min(duration / 3, renewBefore) this should no longer be an issue

Signed-off-by: irbekrm <irbekrm@gmail.com>
@irbekrm
Updates FAQ on cert renewal calculation
01d8a65 
Signed-off-by: irbekrm <irbekrm@gmail.com>
@irbekrm
Adds renewal time period change to 1.4 release docs
744dd2b 
Signed-off-by: irbekrm <irbekrm@gmail.com>
@irbekrm irbekrm force-pushed the update_renewal_docs branch from 01523d0 to 744dd2b Compare June 1, 2021 14:42
@jetstack-bot jetstack-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 1, 2021
@irbekrm irbekrm changed the title WIP Update renewal docs Update renewal docs Jun 1, 2021
@jetstack-bot jetstack-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 1, 2021
@irbekrm irbekrm mentioned this pull request Jun 1, 2021
Merged
@irbekrm irbekrm removed the do-not-merge/cherry-pick-not-approved Indicates that a PR is not yet approved to merge into a release branch. label Jun 1, 2021
@jetstack-bot jetstack-bot added the do-not-merge/cherry-pick-not-approved Indicates that a PR is not yet approved to merge into a release branch. label Jun 1, 2021
@irbekrm
Copy link
Contributor Author

irbekrm commented Jun 1, 2021

Thanks for the review @wallrj !
I've added the https://github.com/cert-manager/website/tree/master/content/en/docs/release-notes/release-1.4.md file and pointed this PR against release-next branch which I've just rebased off master- please take a look.

wallrj
wallrj approved these changes Jun 3, 2021
View reviewed changes
Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve
/lgtm

Thanks Irbe

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Jun 3, 2021
@jetstack-bot
Copy link
Contributor

jetstack-bot commented Jun 3, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irbekrm, wallrj

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@wallrj wallrj added cherry-pick-approved Indicates a cherry-pick PR into a release branch has been approved by the release branch manager and removed do-not-merge/cherry-pick-not-approved Indicates that a PR is not yet approved to merge into a release branch. labels Jun 3, 2021
@jetstack-bot jetstack-bot merged commit 278aa70 into cert-manager:release-next Jun 3, 2021
@irbekrm irbekrm deleted the update_renewal_docs branch June 3, 2021 14:33
@irbekrm irbekrm mentioned this pull request Jun 4, 2021
Closed
This was referenced Jun 7, 2021
Merged
Closed
Merged
This was referenced Jun 15, 2021
Merged
Merged
Merged
@jetstack-bot jetstack-bot mentioned this pull request Aug 11, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wallrj wallrj wallrj approved these changes

Assignees

@wallrj wallrj

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cherry-pick-approved Indicates a cherry-pick PR into a release branch has been approved by the release branch manager dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update info on cert renewal time calculation

3 participants

@irbekrm @jetstack-bot @wallrj