Skip to content

Conversation

@RebeccaTamachiro
Copy link
Contributor

@RebeccaTamachiro RebeccaTamachiro commented Jul 1, 2025

Summary

PCX-11030
PCX-17021
PCX-14675

Documentation checklist

@github-actions github-actions bot added the size/s label Jul 1, 2025
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Jul 1, 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

Revised and consolidated content related to client certificates and mutual TLS (mTLS) across multiple documentation pages.

  • Updated glossary references for mTLS to improve clarity and consistency.
  • Consolidated information about managing client certificates and mTLS implementation.
  • Enhanced descriptions to provide clearer guidance on using Cloudflare's PKI and BYOCA for mTLS.

Modified Files

  • src/content/docs/api-shield/security/mtls/index.mdx
  • src/content/docs/learning-paths/mtls/concepts/index.mdx
  • src/content/docs/ssl/client-certificates/byo-ca.mdx
  • src/content/docs/ssl/client-certificates/index.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 Jul 1, 2025

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

Pattern Owners
/src/content/docs/api-shield/ @patriciasantaana, @cloudflare/pcx-technical-writing
/src/content/docs/learning-paths/ @cloudflare/pcx-technical-writing
/src/content/docs/ssl/ @RebeccaTamachiro, @cloudflare/pcx-technical-writing
* @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

github-actions bot commented Jul 1, 2025

Preview URL: https://07054bde.preview.developers.cloudflare.com
Preview Branch URL: https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/ssl/client-certificates/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/ssl/client-certificates/
https://developers.cloudflare.com/ssl/client-certificates/byo-ca/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/ssl/client-certificates/byo-ca/
https://developers.cloudflare.com/ssl/client-certificates/create-a-client-certificate/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/ssl/client-certificates/create-a-client-certificate/
https://developers.cloudflare.com/ssl/client-certificates/enable-mtls/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/ssl/client-certificates/enable-mtls/
https://developers.cloudflare.com/ssl/client-certificates/forward-a-client-certificate/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/ssl/client-certificates/forward-a-client-certificate/
https://developers.cloudflare.com/api-shield/security/mtls/configure/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/api-shield/security/mtls/configure/
https://developers.cloudflare.com/api-shield/security/mtls/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/api-shield/security/mtls/
https://developers.cloudflare.com/learning-paths/mtls/concepts/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/learning-paths/mtls/concepts/
https://developers.cloudflare.com/learning-paths/mtls/mtls-app-security/related-features/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/learning-paths/mtls/mtls-app-security/related-features/
https://developers.cloudflare.com/learning-paths/mtls/concepts/mtls-cloudflare/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/learning-paths/mtls/concepts/mtls-cloudflare/
https://developers.cloudflare.com/learning-paths/mtls/mtls-app-security/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/learning-paths/mtls/mtls-app-security/
https://developers.cloudflare.com/learning-paths/mtls/mtls-cloudflare-access/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/learning-paths/mtls/mtls-cloudflare-access/
https://developers.cloudflare.com/learning-paths/mtls/mtls-workers/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/learning-paths/mtls/mtls-workers/
https://developers.cloudflare.com/ssl/client-certificates/configure-your-mobile-app-or-iot-device/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/ssl/client-certificates/configure-your-mobile-app-or-iot-device/
https://developers.cloudflare.com/ssl/client-certificates/troubleshooting/ https://rebecca-ssl-consolidate-mtls-byoca.preview.developers.cloudflare.com/ssl/client-certificates/troubleshooting/

@github-actions github-actions bot added size/m and removed size/s labels Jul 2, 2025
@RebeccaTamachiro RebeccaTamachiro marked this pull request as ready for review July 10, 2025 08:25
@github-actions
Copy link
Contributor

github-actions bot commented Jul 18, 2025

This PR requires additional review attention because it affects the following areas:

Partials

This PR updates partial files, which are pieces of content used across multiple files in our Render component.

@RebeccaTamachiro RebeccaTamachiro enabled auto-merge (squash) July 21, 2025 16:05
@RebeccaTamachiro RebeccaTamachiro merged commit 12a93ad into production Jul 21, 2025
8 checks passed
@RebeccaTamachiro RebeccaTamachiro deleted the rebecca/ssl-consolidate-mtls-byoca branch July 21, 2025 16:17
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
* Add (mTLS) to page title

* Review glossary entry and apply mTLS definition throughout

* Link to BYOCA and learning path from client certs landing page

* Review content in byo-ca and adjust page intro

* Remove step-like sections and add new proposed h2s

* Fill in Scope section and delete redundant partial

* Add placeholder text and hyperlinks under #use-cases

* Make CA distiction less wordy and use parallelism for clarity

* Add horizontal break line and DirectoryListing to index.mdx

* Review links out to create-a-client-certificate

* Revise create-a-client-cert for wordiness and consistency with LP

* Text refinement and remove Workers from #next-steps

* Reorder pages

* Separate forward option from enable-mtls page

* Adjust heading and hyperlinks text

* Explicitly call out only one CA per hostname association

* Revert "Explicitly call out only one CA per hostname association"

This reverts commit 721562e.

* Add intro paragraph and change h2 to how-it-works

* Text review

* Review enable-mtls leveraging LP and new content in this PR

* Replace placeholder in #use-cases and add more info about workers

* General text review

* Explicitly mention and link to BYOCA from LP and #use-cases

* Fix broken anchors

* Fix info on requests including Cf-Client-Cert headers

* Text review

* Add section about multiple CAs for the same hostname

* Remove DirectoryListing from overview page

* Remove additional warning from enable-mtls and delete partial

* Apply changes following PM review

* Remove remaining mention of account-specific CA

* Improve consistency for hyperlinks to learning path

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

* Fix capitalization

---------

Co-authored-by: marciocloudflare <[email protected]>
thomasgauvin pushed a commit that referenced this pull request Aug 15, 2025
* Add (mTLS) to page title

* Review glossary entry and apply mTLS definition throughout

* Link to BYOCA and learning path from client certs landing page

* Review content in byo-ca and adjust page intro

* Remove step-like sections and add new proposed h2s

* Fill in Scope section and delete redundant partial

* Add placeholder text and hyperlinks under #use-cases

* Make CA distiction less wordy and use parallelism for clarity

* Add horizontal break line and DirectoryListing to index.mdx

* Review links out to create-a-client-certificate

* Revise create-a-client-cert for wordiness and consistency with LP

* Text refinement and remove Workers from #next-steps

* Reorder pages

* Separate forward option from enable-mtls page

* Adjust heading and hyperlinks text

* Explicitly call out only one CA per hostname association

* Revert "Explicitly call out only one CA per hostname association"

This reverts commit 721562e.

* Add intro paragraph and change h2 to how-it-works

* Text review

* Review enable-mtls leveraging LP and new content in this PR

* Replace placeholder in #use-cases and add more info about workers

* General text review

* Explicitly mention and link to BYOCA from LP and #use-cases

* Fix broken anchors

* Fix info on requests including Cf-Client-Cert headers

* Text review

* Add section about multiple CAs for the same hostname

* Remove DirectoryListing from overview page

* Remove additional warning from enable-mtls and delete partial

* Apply changes following PM review

* Remove remaining mention of account-specific CA

* Improve consistency for hyperlinks to learning path

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

* Fix capitalization

---------

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants