new: mTLS guides

[julia-rabello]

Types of changes

• New content (guides, endpoints, app documentation)
• Improvement (make a documentation even better)
• Fix (fix a documentation error)
• Spelling and grammar accuracy (self-explanatory)

[github-actions]

Navigation Preview Link

No changes detected in the navigation.json file

[github-actions]

Preview Links

Open this URL to set up the portal with this branch changes.

You can now access the edited pages with the following URLs:

• Couldn't find the corresponding page for docs/guides/VTEX. Have you added VTEX to the navigation.json file? Maybe you can find it in https://developers.vtex.com/docs/guides/VTEX
• Couldn't find the corresponding page for Shield/implementing-mtls.md. Have you added implementing-mtls to the navigation.json file? Maybe you can find it in https://developers.vtex.com/docs/guides/implementing-mtls
• Couldn't find the corresponding page for docs/guides/VTEX. Have you added VTEX to the navigation.json file? Maybe you can find it in https://developers.vtex.com/docs/guides/VTEX
• Couldn't find the corresponding page for Shield/revoking-ssl-private-certificates-when-using-mtls.md. Have you added revoking-ssl-private-certificates-when-using-mtls to the navigation.json file? Maybe you can find it in https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls

[github-actions]

Frontmatter errors in docs/guides/VTEX Shield/revoking-ssl-private-certificates-when-using-mtls.md:

• 'slug' must match the filename without extension.

[github-actions]

Grammar review summary

Review for docs/guides/VTEX Shield/implementing-mtls.md

The document is well-written with only two minor issues identified: a redundant phrase and a slightly informal word choice. The overall grammar, spelling, and typography are excellent.

Review for docs/guides/VTEX Shield/revoking-ssl-private-certificates-when-using-mtls.md

The document is well-written with clear and concise language. The grammar and spelling are excellent. The only identified issues are minor typographic inconsistencies in the use of hyphens and en dashes in subheadings, which can be standardized for improved readability.

---

Was this feedback useful?

• Yes
• No

[github-actions]

Grammar review summary

Review for docs/guides/VTEX Shield/implementing-mtls.md

The document is well-written and clear. The identified issues are minor, primarily involving typographic inconsistency in anchor links and a slight redundancy in one sentence. Addressing these will improve the overall polish and ensure correct navigation within the document.

Review for docs/guides/VTEX Shield/revoking-ssl-private-certificates-when-using-mtls.md

The document is well-written with only one minor redundancy identified. The use of en dashes in headings is typographically correct.

---

Was this feedback useful?

• Yes
• No

[github-actions]

Grammar review summary

Review for docs/guides/VTEX Shield/implementing-mtls.md

The document is well-written and clear. The only identified issues are minor typographic inconsistencies in the main headings, where hyphens should be replaced with en dashes for better readability and adherence to common technical documentation style guides.

Review for docs/guides/VTEX Shield/revoking-ssl-private-certificates-when-using-mtls.md

The document is well-written with only minor capitalization issues for common nouns like 'endpoint' and sentence beginnings.

---

Was this feedback useful?

• Yes
• No

[github-actions]

Grammar review summary

Review for docs/guides/VTEX Shield/implementing-mtls.md

The document is well-structured and clear. The primary areas for improvement involve consistent capitalization of proper nouns, specific technical terms, UI elements, and ensuring typographic consistency for internal link anchors.

Review for docs/guides/VTEX Shield/revoking-ssl-private-certificates-when-using-mtls.md

The document is well-written with only minor typographic inconsistencies and a missing space identified. Corrections focus on standardizing dash usage in headings and improving readability around icons.

---

Was this feedback useful?

• Yes
• No

[github-actions]

Grammar review summary

Review for docs/guides/VTEX Shield/implementing-mtls.md

The document is well-written and clear. Two minor issues were identified: an inconsistent hyphenation in an internal link and a dangling participle. Corrections have been provided for both to enhance clarity and grammatical accuracy.

Review for docs/guides/VTEX Shield/revoking-ssl-private-certificates-when-using-mtls.md

The document is well-written with only two minor issues: a capitalization error at the start of a sentence and an inconsistent use of an en-dash instead of a hyphen in a section title.

---

Was this feedback useful?

• Yes
• No

[github-actions]

Grammar review summary

Review for docs/guides/VTEX Shield/implementing-mtls.md

The document is well-written and grammatically correct. No issues were found regarding grammar, spelling, or typography.

Review for docs/guides/VTEX Shield/revoking-ssl-private-certificates-when-using-mtls.md

The document is well-written with only one minor typographic suggestion for improved readability in a callout.

---

Was this feedback useful?

• Yes
• No

[github-actions]

Grammar review summary

Review for docs/guides/VTEX Shield/implementing-mtls.md

The document is well-written with only a minor stylistic suggestion for improved clarity in one sentence.

Review for docs/guides/VTEX Shield/revoking-ssl-private-certificates-when-using-mtls.md

The document is well-written and clear. Minor improvements include using 'that' for restrictive clauses, ensuring consistent use of hyphens in headings, and removing redundant phrasing like 'status code error'.

---

Was this feedback useful?

• Yes
• No

[github-actions]

📝 [Grammar reviewer] _{reported by reviewdog 🐶}
Rephrased for improved clarity and flow, replacing an absolute phrase with a more direct temporal clause.

Suggested change

	With the certificate issued, you can now authenticate your requests to VTEX using mTLS. See examples using [Postman](https://www.postman.com/) and cURL below.
	Once the certificate is issued, you can now authenticate your requests to VTEX using mTLS. See examples using [Postman](https://www.postman.com/) and cURL below.

[github-actions]

📝 [Grammar reviewer] _{reported by reviewdog 🐶}
Use 'that' instead of 'which' for restrictive clauses. The clause 'allows you to revoke a certificate using its serial number' is essential to define the type of endpoint, making it a restrictive clause.

Suggested change

For security reasons, when using [mTLS](https://help.vtex.com/en/tutorial/mutual-transport-layer-security-mtls--6YR3SoynJMfeEKGlY1Cqlo), you may need to revoke previously issued certificates if they're compromised or no longer needed. VTEX provides a `DELETE` [Revoke certificate](https://developers.vtex.com/docs/api-reference/mtls-api#delete-/api/edge/private-certificates/-serialNumber-) endpoint, which allows you to revoke a certificate using its serial number.

For security reasons, when using [mTLS](https://help.vtex.com/en/tutorial/mutual-transport-layer-security-mtls--6YR3SoynJMfeEKGlY1Cqlo), you may need to revoke previously issued certificates if they're compromised or no longer needed. VTEX provides a `DELETE` [Revoke certificate](https://developers.vtex.com/docs/api-reference/mtls-api#delete-/api/edge/private-certificates/-serialNumber-) endpoint that allows you to revoke a certificate using its serial number.

[github-actions]

📝 [Grammar reviewer] _{reported by reviewdog 🐶}
For consistency with other headings (e.g., 'Step 1 - Getting the certificate serial number' and 'Method 1 - Hex string without colons'), use a hyphen (-) instead of an en dash (–) as a separator in the heading.

Suggested change

	### Method 2 – Colon-separated hexadecimal format
	### Method 2 - Colon-separated hexadecimal format

[github-actions]

📝 [Grammar reviewer] _{reported by reviewdog 🐶}
The phrase 'status code error' is redundant. '403 error' or '403 status code' is sufficient and more concise.

Suggested change

	The user or application must have the following License Manager resource to make this call. Otherwise, a 403 status code error will be returned.
	The user or application must have the following License Manager resource to make this call. Otherwise, a 403 error will be returned.