feat: update secretTemplate documentation by jonathansp · Pull Request #634 · cert-manager/website

jonathansp · 2021-06-30T16:29:22Z

Signed-off-by: jonathansp jonathansimonprates@gmail.com

Update docs to include cert-manager/cert-manager#3828 feature.

jetstack-bot · 2021-06-30T16:29:31Z

Hi @jonathansp. Thanks for your PR.

I'm waiting for a cert-manager member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

jonathansp · 2021-06-30T16:29:51Z

/assign @jakexks

wallrj · 2021-06-30T17:01:19Z

/ok-to-test

Thanks for all your work on this @jonathansp

maelvls · 2021-07-02T13:55:51Z

content/en/docs/usage/certificate.md

+If `secretTemplate` is present, annotations and labels set in this property
+will be copied over to `example-com-tls` secret. Both properties are optional.


Just wondering, how do we let people know that this is a feature that only exists since 1.5? The user would have to look for differences between 1.4 and 1.5 to find that out.

I'd go with smth like:

Suggested change

If `secretTemplate` is present, annotations and labels set in this property

will be copied over to `example-com-tls` secret. Both properties are optional.

If `secretTemplate` _(since cert-manager 1.5)_ is present, annotations and labels set in this property

will be copied over to `example-com-tls` secret. Both properties are optional.

@irbekrm what do you think? 😅

Our docs are versioned so I don't think this is too much of a concern.

@JoshVanL I find it very frustrating to have to select one by one the documentation versions to find when a feature was introduced and know if your version of cert-manager works with that feature, since Google always returns the latest version of the pages.

I am often in the situation where I start using a feature and realize later on that the feature was introduced in a later version. This happened 3 times in the last month while using Traefik. I just wish they had a tiny note on every Ingress annotation that reminds me "when" this annotation was added.

I guess we may want to merge this into release-next branch, not into master though?

updated and rebased @irbekrm

I've just added a release note based on the PR description and code comments, let me know if it needs to be rewritten. @benlangfeld I took the liberty to add your name to the contributors' list above.

Looks like our stupid spellchecker doesn't like the github usernames. You'll have to add them to the .spelling file. See https://github.com/cert-manager/website/blame/master/.spelling#L265

Usernames added to .spelling.

@jonathansp I'm flattered, but I didn't do anything nearly worth being included in a list of contributors :)

netlify · 2021-08-03T10:14:48Z

✔️ Deploy Preview for cert-manager-website ready!

🔨 Explore the source changes: 66a75bd

🔍 Inspect the deploy log: https://app.netlify.com/sites/cert-manager-website/deploys/610a813736af840008b14b1b

😎 Browse the preview: https://deploy-preview-634--cert-manager-website.netlify.app

content/en/docs/usage/certificate.md

wallrj

@jonathansp Please update the PR to be merged in to the release-next branch (as @irbekrm mentioned above)

That's the branch containing the documentation and release notes for the upcoming 1.5 release, which will be the first release containing your secret template work.

Thanks.

wallrj · 2021-08-03T17:05:29Z

@jonathansp Also please update the release-notes page with a paragraph about the new secret template feature. Thanks.

https://github.com/cert-manager/website/blob/release-next/content/en/docs/release-notes/release-notes-1.5.md

maelvls · 2021-08-04T10:05:03Z

@jonathansp Do you think you could click "Edit" on the PR and select "release-next" instead of "master" as the base branch? That would probably also require a rebase onto release-next. Please let me know if you need help with that.

jonathansp · 2021-08-04T10:19:18Z

@jonathansp Do you think you could click "Edit" on the PR and select "release-next" instead of "master" as the base branch? That would probably also require a rebase onto release-next. Please let me know if you need help with that.

Sorry @maelvls, couple of meetings this morning. Will do.

Signed-off-by: jonathansp <jonathansimonprates@gmail.com>

wallrj

Thanks again. This looks great.

/lgtm
/approve

wallrj · 2021-08-04T11:11:19Z

content/en/docs/release-notes/release-notes-1.5.md

 Special thanks to the external contributors who contributed to this release:
- TODO
+
+* [@jonathansp](https://github.com/jonathansp)


jonathansp · 2021-08-04T11:55:24Z

/retest

Signed-off-by: jonathansp <jonathansimonprates@gmail.com>

wallrj

/lgtm

jetstack-bot · 2021-08-04T13:30:05Z

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: jonathansp, 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:

OWNERS

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

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. labels Jun 30, 2021

jetstack-bot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 30, 2021

jetstack-bot assigned jakexks Jun 30, 2021

jetstack-bot added ok-to-test and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 30, 2021

maelvls reviewed Jul 2, 2021

View reviewed changes

jonathansp marked this pull request as ready for review July 5, 2021 17:02

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 Jul 5, 2021

maelvls mentioned this pull request Jul 19, 2021

Apply Cert Secret Labels cert-manager/cert-manager#2992

Closed

jonathansp commented Aug 3, 2021

View reviewed changes

content/en/docs/usage/certificate.md Outdated Show resolved Hide resolved

irbekrm reviewed Aug 3, 2021

View reviewed changes

content/en/docs/usage/certificate.md Outdated Show resolved Hide resolved

benlangfeld reviewed Aug 3, 2021

View reviewed changes

content/en/docs/usage/certificate.md Outdated Show resolved Hide resolved

wallrj requested changes Aug 3, 2021

View reviewed changes

wallrj mentioned this pull request Aug 3, 2021

Add a blank release notes and upgrade page for v1.5 #666

Merged

jonathansp requested a review from wallrj August 4, 2021 11:09

chore: add SecretTemplate to release note and update contributors list

a4282eb

Signed-off-by: jonathansp <jonathansimonprates@gmail.com>

jetstack-bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. and removed dco-signoff: no Indicates that at least one commit in this pull request is missing the DCO sign-off message. labels Aug 4, 2021

wallrj approved these changes Aug 4, 2021

View reviewed changes

jetstack-bot assigned wallrj Aug 4, 2021

jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 4, 2021

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 Aug 4, 2021

chore: update .spelling file

66a75bd

Signed-off-by: jonathansp <jonathansimonprates@gmail.com>

jetstack-bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. and removed dco-signoff: no Indicates that at least one commit in this pull request is missing the DCO sign-off message. labels Aug 4, 2021

wallrj approved these changes Aug 4, 2021

View reviewed changes

jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 4, 2021

wallrj added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 4, 2021

jetstack-bot merged commit 4b5a826 into cert-manager:release-next Aug 4, 2021

This was referenced Aug 11, 2021

Merge release-next into master for the 1.5 release #675

Merged

Update build scripts for 1.5 #680

Merged

jetstack-bot mentioned this pull request Oct 27, 2021

Update the release-1.5 branch #732

Merged

		If `secretTemplate` is present, annotations and labels set in this property
		will be copied over to `example-com-tls` secret. Both properties are optional.

Conversation

jonathansp commented Jun 30, 2021

Uh oh!

jetstack-bot commented Jun 30, 2021

Uh oh!

jonathansp commented Jun 30, 2021

Uh oh!

wallrj commented Jun 30, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maelvls Jul 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

netlify bot commented Aug 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wallrj left a comment

Choose a reason for hiding this comment

Uh oh!

wallrj commented Aug 3, 2021

Uh oh!

maelvls commented Aug 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonathansp commented Aug 4, 2021

Uh oh!

wallrj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonathansp commented Aug 4, 2021

Uh oh!

wallrj left a comment

Choose a reason for hiding this comment

Uh oh!

jetstack-bot commented Aug 4, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

maelvls Jul 29, 2021 •

edited

Loading

netlify bot commented Aug 3, 2021 •

edited

Loading

maelvls commented Aug 4, 2021 •

edited

Loading