Rewrite reference page descriptions (next trees)#2711
Open
ctauchen wants to merge 1 commit intotigera:mainfrom
Open
Rewrite reference page descriptions (next trees)#2711ctauchen wants to merge 1 commit intotigera:mainfrom
ctauchen wants to merge 1 commit intotigera:mainfrom
Conversation
Replaces the description frontmatter on every reference page across the three unversioned source trees with descriptions that name one canonical product, fit in 200 chars, and disambiguate identically-named CRDs and calicoctl commands across products. No body changes; one line per file. The four auto-generated _api.mdx / _ia-api.mdx files are intentionally skipped (regenerated from the operator schema, already excluded by Vale). The unversioned _README.mdx in calico-cloud/reference/installation/ is also skipped because it has no frontmatter (developer-only file).
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the
descriptionfrontmatter on every page in the reference book across the three unversioned (next-release) source trees — 333 files, 1-line replacement each. Same rule set as #2696, #2697, and #2710.calico/reference/calico-enterprise/reference/calico-cloud/reference/This PR is next-only on purpose — landing on the unversioned source first so the descriptions can get review without being pre-mirrored to versioned snapshots that would all need amending if anything changes. After review, I will mirror to the published latest-version snapshots in a follow-up.
Intentionally skipped
Five files in
*/reference/installation/are not touched:calico/reference/installation/_api.mdxcalico-enterprise/reference/installation/_api.mdxcalico-cloud/reference/installation/_api.mdxcalico-cloud/reference/installation/_ia-api.mdx— the four auto-generated CRD reference files, regenerated from the operator schema (already excluded by.vale.ini).calico-cloud/reference/installation/_README.mdx— developer-only README with no frontmatter; underscore-prefixed so Docusaurus excludes it from the build.What every new description follows
Calico Open Source,Calico Enterprise,Calico Cloud).docs-frontmatter-descriptionskill — "reference" is worked into the sentence rather than used as a label prefix.enable,disable, orteaching.data plane/dataplane,IPAM/ipam,BGP/bgpterm-rule violations.Cross-product disambiguation
Reference is dominated by CRD docs and command-line reference. Disambiguation strategy:
... resource in Calico Open Source ...,calicoctl ..., upstream-project context.... resource in Calico Enterprise ..., references to tiers, recommendations, observability, the management UI.... resource in Calico Cloud connected clusters ...,Calico Cloud web console, "across connected clusters."For functionally identical CRDs the canonical product name in the resource phrasing is the primary disambiguator.
What was wrong before
Pre-fix snapshot of the same files:
Configure Resource requests and limits.,Command to apply a policy.,Command to delete a policy.,REST API reference, plus the entire calicoctl command surface. All disambiguated by the rules above.Verification
Run from repo root on this branch:
Length, canonical-name presence, and cross-product-uniqueness checks are equivalent one-liners over the same three directories. All four return empty post-fix.
Test plan
resources/felixconfiguration.mdx,resources/bgpconfiguration.mdx,resources/hostendpoint.mdx) for distinguishability.calico/andcalico-enterprise/.calico_versioned_docs/version-3.32/reference/,calico-enterprise_versioned_docs/version-3.23-1/reference/,calico-enterprise_versioned_docs/version-3.22-2/reference/,calico-cloud_versioned_docs/version-22-2/reference/).