Skip to content

Docs 1679 follow-up#1685

Merged
wallrj merged 6 commits intocert-manager:masterfrom
jsoref:docs-1679-followup
May 8, 2025
Merged

Docs 1679 follow-up#1685
wallrj merged 6 commits intocert-manager:masterfrom
jsoref:docs-1679-followup

Conversation

@jsoref
Copy link
Copy Markdown
Contributor

@jsoref jsoref commented May 7, 2025

jsoref added 3 commits May 7, 2025 07:31
@jsoref
docs: Guess the end of the sentence...
94a1f9f 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
docs: Reflow comment paragraph
c0806b0 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
docs: improve link a11y
3615b6e 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@cert-manager-prow cert-manager-prow bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 7, 2025
jsoref
jsoref commented May 7, 2025
View reviewed changes
README.md

If you're adding a top-level page which should only appear in the `docs/` section (such as the existing "contributing" section)
then add `"x-only-docs": true` underneath the title in `manifest.json`. This will cause that section to be removed when a new versioned docs section.
then add `"x-only-docs": true` underneath the title in `manifest.json`. This will cause that section to be removed when a new versioned docs section is added.
Copy link
Copy Markdown
Contributor Author

@jsoref jsoref May 7, 2025

Choose a reason for hiding this comment

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

I'm not sure about this one as the sentence trailed off ☹️

@jsoref
Copy link
Copy Markdown
Contributor Author

jsoref commented May 7, 2025

/assign wallrj

@wallrj wallrj self-requested a review May 7, 2025 11:45
wallrj
wallrj requested changes May 7, 2025
View reviewed changes
Copy link
Copy Markdown
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.

Thanks. Some of these changes are in auto-generated files so we need to fix them in the cert-manager source code or the code-generator template.

content/v1.16-docs/reference/api-docs.md
Copy link
Copy Markdown
Member

@wallrj wallrj May 7, 2025

Choose a reason for hiding this comment

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

Revert this and fix it in the cert-manager pkg/apis/ code, not here.

jsoref added 3 commits May 7, 2025 11:57
@jsoref
docs: harmonize <p> formatting by dropping internal spaces
0f00b44 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
docs: spelling e.g.,
464caaa 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref
docs: improve link a11y
9c2dc17 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
@jsoref jsoref force-pushed the docs-1679-followup branch from 191b377 to 9c2dc17 Compare May 7, 2025 16:27
@cert-manager-prow cert-manager-prow bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 7, 2025
@netlify
Copy link
Copy Markdown

netlify bot commented May 7, 2025

✅ Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 9c2dc17
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager/deploys/681b8a022749bc0008a5b5c7
😎 Deploy Preview https://deploy-preview-1685--cert-manager.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

This was referenced May 7, 2025
Open
Closed
Merged
wallrj
wallrj approved these changes May 8, 2025
View reviewed changes
Copy link
Copy Markdown
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.

Thanks Josh,

It looks like you're addressing some of my earlier comments in separate PRs. Fine.

/approve
/lgtm

@cert-manager-prow
Copy link
Copy Markdown
Contributor

cert-manager-prow bot commented May 8, 2025

[APPROVALNOTIFIER] This PR is APPROVED

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

@cert-manager-prow cert-manager-prow bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels May 8, 2025
@wallrj wallrj merged commit 983fabe into cert-manager:master May 8, 2025
7 checks passed
@jsoref jsoref deleted the docs-1679-followup branch May 8, 2025 17:36
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. 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/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jsoref @wallrj