Skip to content
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

Improved the summary on the docs homepage #1071

Merged
merged 8 commits into from
Feb 16, 2024

Conversation

wallrj
Copy link
Member

@wallrj wallrj commented Sep 7, 2022

Preview: https://deploy-preview-1071--cert-manager-website.netlify.app/docs/

The opening paragraph of the docs/ homepage was a bit waffly,
so we've tried to get straight to the point and linked to the internal pages about each supported CA rather than sending visitors off to external sites before they've read about the cert-manager integration with each of the CAs.

@jetstack-bot jetstack-bot added 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 Sep 7, 2022
@wallrj wallrj requested a review from SgtCoDFish September 7, 2022 16:51
content/docs/README.md Outdated Show resolved Hide resolved
content/docs/README.md Show resolved Hide resolved
@wallrj
Copy link
Member Author

wallrj commented Sep 7, 2022

/cc @jsoref In case you have a few minutes to proof read this.

@netlify
Copy link

netlify bot commented Sep 7, 2022

Deploy Preview for cert-manager-website ready!

Name Link
🔨 Latest commit 97f5bb2
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager-website/deploys/65cf4fb58e35140008d64009
😎 Deploy Preview https://deploy-preview-1071--cert-manager-website.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.

content/docs/README.md Outdated Show resolved Hide resolved
@jetstack-bot jetstack-bot added dco-signoff: no Indicates that at least one commit in this pull request is missing the DCO sign-off message. and removed dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. labels Sep 8, 2022
@wallrj wallrj force-pushed the improved-docs-homepage branch from 41a3b34 to baf88a3 Compare September 8, 2022 06:28
@jetstack-bot 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 Sep 8, 2022
content/docs/README.md Outdated Show resolved Hide resolved
content/docs/README.md Outdated Show resolved Hide resolved
@inteon
Copy link
Member

inteon commented Nov 20, 2023

@wallrj could you take a look at the comments I posted?
I think this could be a great improvement and would like to see this merged.

@jetstack-bot jetstack-bot removed the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 16, 2024
wallrj and others added 7 commits February 16, 2024 11:45
Link to internal pages about each issuer

Signed-off-by: Richard Wall <[email protected]>
Signed-off-by: Richard Wall <[email protected]>
Co-authored-by: Josh Soref <[email protected]>
Signed-off-by: Richard Wall <[email protected]>
Co-authored-by: Tim Ramlot <[email protected]>
Signed-off-by: Richard Wall <[email protected]>
@wallrj wallrj force-pushed the improved-docs-homepage branch from be184b7 to bd2a79b Compare February 16, 2024 11:58
Signed-off-by: Richard Wall <[email protected]>
@wallrj wallrj requested a review from inteon February 16, 2024 12:03
Copy link
Member

@inteon inteon left a comment

Choose a reason for hiding this comment

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

Thanks @wallrj
This looks very good!
/lgtm
/approve

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Feb 16, 2024
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: inteon

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jetstack-bot jetstack-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 16, 2024
@jetstack-bot jetstack-bot merged commit d6f47c8 into cert-manager:master Feb 16, 2024
8 checks passed
@wallrj wallrj deleted the improved-docs-homepage branch February 16, 2024 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

6 participants