Skip to content

docs(guides): remove the residual "These checks confirm" use-case lines - #2611

Open
bruno-andrade-azion wants to merge 1 commit into
mainfrom
docs/mm-16252-remove-use-case-template-residue
Open

bruno-andrade-azion wants to merge 1 commit into
mainfrom
docs/mm-16252-remove-use-case-template-residue

Conversation

@bruno-andrade-azion

@bruno-andrade-azion bruno-andrade-azion commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

What & why

Related issue: MM-16252 (T40) · Epic MM-16212
Pages affected: 32 en guides and their 32 pt-br twins (see the diff). The en pages are in the Applications, Availability, Data, AI, Security, Observability and Streaming guides, plus point-domain, integrate-siems and the WAF apply-rule-set example.

#2457 moved use-case values and checks into the guides. It also left one line at the end of many confirm sections, These checks confirm the [<use case>](…) use case. (pt-br: Estas verificações confirmam o caso de uso […](…).). The how-to style guide (style-guide/content/how-to-guides.mdx) defines only two use-case lines, "…uses the values of this example" and "In the […] use case, expect:", so these lines are template residue. Some pages stacked two or three of them back to back (point-domain, integrate-siems, restrict-an-origin-to-azion-with-origin-ip-acl), and others repeated a use case that the section had just named.

This PR deletes all 39 lines in en and the 39 matching lines in pt-br, with one blank line each. Nothing else changes.

  • No link is lost. Every page still links each of those use cases: 38 of the 39 through a Next steps card, and image-processor through three references in the body. The use-case pages also still link to these guides.
  • Convention lines are untouched. The "uses the values of this example", "takes these values:" and "expect:" lines stay.
  • Scope is wider than the ticket's ~10 pages. The ticket names the Applications cluster, but the same residue was reported in cluster 2 (finding edu-1828-update-guides #38, integrate-siems), cluster 4 (EDU-2020-Remove-guides-from-Edge-Application-Ciphers #32, create-mcp and route-an-api-path-to-a-backend) and cluster 6 (EDU-1988-update-reference-rte #25, debug-functions-dts), and none of those has its own task. The fix is the same everywhere, so this PR covers all of them.

How I checked it

Known gap, out of scope: in debug-functions-dts, the "Screen file uploads for malicious content" use case has a Next steps card but no "expect:" block, while the other two use cases on the page do. Writing that block is content work, not cleanup.

Type of change

  • 🆕 New content (feat)
  • 🩹 Fix (fix) — typo, broken link, wrong information
  • ♻️ Content update (docs) — rewrite, expansion, upkeep
  • 🌐 Translation sync (i18n)
  • 🏗️ Platform / structure (refactor / chore) — reviewed by UXE, no content mixed in

Author checklist

  • PR title follows type(scope): summary (see GOVERNANCE.md §4)
  • Frontmatter complete: title, description, meta_tags, namespace, permalink, last_reviewed — no frontmatter is added or changed
  • No legacy "edge-" product names in the copy — no copy is added
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — no code block is added or changed
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally — no link is added or changed
  • If any permalink changed or page moved: redirect added in this PR — no permalink changed and no page moved
  • i18n: pt-br updated in this PR or follow-up i18n issue created: — pt-br is updated in this PR
  • I ran pnpm build:local (build + frontmatter check) without errors — not run: the change only deletes whole paragraphs and touches no MDX syntax, frontmatter, or links; CI builds the branch

…es (MM-16252)

PR #2457 left a "These checks confirm the <use case> use case." line at the
end of the confirm sections of 32 guides, and its pt-br twin in the same 32
pages. The how-to style guide defines only two use-case lines ("uses the
values of this example" and "use case, expect:"), so these lines are
template residue. Every page still links each use case from a Next steps
card or from the body, so no link is lost.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants