Skip to content

[CF1] signing cert clarification #22699

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 4, 2025
Merged

[CF1] signing cert clarification #22699

merged 4 commits into from
Jun 4, 2025

Conversation

@deadlypants1973
Copy link
Contributor

@deadlypants1973 deadlypants1973 commented May 27, 2025 •
edited
Loading

Summary

PCX-16969

Need to clarify further on root CA wording in instructions

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@deadlypants1973 deadlypants1973 requested review from a team, kennyj42 and ranbel as code owners May 27, 2025 17:12
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented May 27, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Clarified the requirements for uploading signing certificates in client certificate posture checks.

  • Added a caution note regarding the upload of the signing certificate for client certificates.
  • Specified that the signing certificate may be an intermediate CA, not necessarily the root CA.
  • Emphasized the importance of uploading the correct signing certificate to avoid posture check failures.

Modified Files

  • src/content/docs/cloudflare-one/identity/devices/warp-client-checks/client-certificate.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions
Copy link
Contributor

github-actions bot commented May 27, 2025 •
edited
Loading

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/cloudflare-one/connections/connect-devices/ @kkrum, @kokolocomotion1, @ranbel, @cloudflare/pcx-technical-writing
/src/content/docs/cloudflare-one/identity/ @kennyj42, @ranbel, @cloudflare/pcx-technical-writing
* @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

github-actions bot commented May 27, 2025 •
edited
Loading

Preview URL: https://992525f4.preview.developers.cloudflare.com
Preview Branch URL: https://kate-fixes-certificatecheck.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/cloudflare-one/identity/devices/warp-client-checks/client-certificate/ https://kate-fixes-certificatecheck.preview.developers.cloudflare.com/cloudflare-one/identity/devices/warp-client-checks/client-certificate/
https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/user-side-certificates/custom-certificate/ https://kate-fixes-certificatecheck.preview.developers.cloudflare.com/cloudflare-one/connections/connect-devices/user-side-certificates/custom-certificate/

@github-actions github-actions bot added size/s and removed size/xs labels May 30, 2025
ranbel
ranbel reviewed Jun 2, 2025
View reviewed changes
src/content/partials/cloudflare-one/upload-mtls-cert.mdx
import { Markdown } from "~/components";

Use the [Upload mTLS certificate endpoint](/api/resources/mtls_certificates/methods/create/) to upload the certificate and private key to Cloudflare. The certificate must be a root CA, formatted as a single string with `\n` replacing the line breaks. {props.one}
Use the [Upload mTLS certificate endpoint](/api/resources/mtls_certificates/methods/create/) to upload the certificate and private key to Cloudflare. The certificate must be a {props.cert}, formatted as a single string with `\n` replacing the line breaks. {props.one}
Copy link
Contributor

@ranbel ranbel Jun 2, 2025

Choose a reason for hiding this comment

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

Recommend adding cert to the inputParameters frontmatter.
https://developers.cloudflare.com/style-guide/components/render/#defining-expected-properties-in-frontmatter

Copy link
Contributor

@ranbel ranbel Jun 2, 2025

Choose a reason for hiding this comment

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

Also recommend renaming props.one to something more descriptive. I think it's a remnant from the old way of doing partials.

@deadlypants1973 deadlypants1973 merged commit 8229470 into production Jun 4, 2025
11 checks passed
@deadlypants1973 deadlypants1973 deleted the kate/fixes-certificatecheck branch June 4, 2025 15:28
@deadlypants1973 deadlypants1973 mentioned this pull request Jun 4, 2025
Merged
3 tasks
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
@deadlypants1973 @aw-cf @sdnts
[CF1] signing cert clarification (cloudflare#22699)
1bcfcb3 
* [CF1] signing cert clarification

* signing cert clarification

* more wording

* Apply suggestions from code review

Co-authored-by: Andreas <[email protected]>

---------

Co-authored-by: Andreas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ranbel ranbel ranbel approved these changes

@kennyj42 kennyj42 Awaiting requested review from kennyj42 kennyj42 is a code owner

+1 more reviewer

@aw-cf aw-cf aw-cf left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@kennyj42 kennyj42

@ranbel ranbel

Labels

product:cloudflare-one size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@deadlypants1973 @ranbel @aw-cf @kennyj42