fix(docs): six source defects the new translation checks brought to light - #1064
Open
youyongsong wants to merge 2 commits into
Open
fix(docs): six source defects the new translation checks brought to light#1064youyongsong wants to merge 2 commits into
youyongsong wants to merge 2 commits into
Conversation
…light
None of these were visible before. Two were hidden by a lint bug that discarded
messages on a trailing self-closing component; the other two only showed up
because translations are now compared against the source they were made from.
- `networking/how_to/kube_ovn/underlay_overlay_st.mdx` — the frontmatter had no
opening `---`, so `weight: 13` was not frontmatter at all: it rendered as a
second-level heading at the top of the page, and the weight never applied.
- `developer/s2i/install_builds/install_builds_operator.mdx` — one sentence was
split across two list items, so the table read "When a new version is
available in the OperatorHub" and "the **Upgrade** action will not be executed
automatically" as two separate points. The Russian translation reproduced the
split faithfully.
- `apis/advanced_apis/application/query.mdx` and `management.mdx` — two
`<OpenAPIPath>` paths spell the parameter `{cluster}`, while every OpenAPI
source spells it `{cluster_name}`. The endpoint sections rendered blank.
The translations are updated to match in
`auto-translations/container_platform!1`.
Deploying alauda-container-platform with
|
| Latest commit: |
9246481
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://86ae289c.alauda-container-platform.pages.dev |
| Branch Preview URL: | https://fix-docs-defects-found-by-tr.alauda-container-platform.pages.dev |
`**bold**` only works when the delimiters sit against the text. These two do not, so readers see the asterisks: - `developer/quick_start/quick_start_app.mdx` — a table header written `|** Parameter **|`. The opening run is followed by a space, which makes it not an opening delimiter at all, and the header cell reads "** Parameter **". - `developer/building_application/application_workloads/cronjob_create.mdx` — a stray closing `**` after "Failed jobs history limit". The sibling bullet one line above ends "Successful jobs history limit (default: 20)" with no such marker. Both are also the source of the same defect in the Russian pages, which reproduced the broken markup faithfully. Changing the English updates their `sourceSHA`, so the translations are retranslated on the next run and the defect goes with them. Found by a new `no-unparsed-emphasis` lint rule rather than by reading: measured across this repository it reports 2 English documents out of 922, and both are these. Once doom ships that rule, these two would turn the English lint red.
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.
Six defects in the English source, none of which were visible before.
Two were hidden by a lint bug that discarded messages landing on a trailing self-closing component — a canonical API reference page is exactly that shape. Two only showed up once translations started being compared against the source they were made from. The last two were found by a new lint rule,
no-unparsed-emphasis, written after a translation produced the same shape of defect.networking/how_to/kube_ovn/underlay_overlay_st.mdxThe frontmatter has no opening
---:So
weight: 13was never frontmatter. Markdown readsweight: 13followed by---as a setext heading, which means the page renders a second-level heading titledweight: 13above its own title, and the weight never applies to the sidebar.Found by comparing heading structure with the translations: the source parsed as
2-1-2-3-2-3-3where both translations were1-2-3-2-3-3. It now has a lint rule of its own —no-unopened-frontmatter, which reports this shape without reporting the 88 documents in this repository that legitimately have no frontmatter at all.developer/s2i/install_builds/install_builds_operator.mdxOne sentence split across two list items:
The table therefore reads them as two separate points, the second of which is a sentence fragment. The Russian translation reproduced the split faithfully; the Chinese quietly merged them, which is what surfaced the difference.
apis/advanced_apis/application/query.mdxandmanagement.mdxTwo
<OpenAPIPath>paths spell the parameter{cluster}:Every path under
applicationsin the OpenAPI sources spells it{cluster_name}— including the/addresspath sitting on the very next line ofquery.mdx. A path that matches nothing renders a blank endpoint section, silently.developer/quick_start/quick_start_app.mdxandapplication_workloads/cronjob_create.mdxEmphasis delimiters that end up printed to the page.
**bold**only works when the delimiters sit against the text:The opening run is followed by a space, so it is not an opening delimiter and the header cell reads
** Parameter **. Incronjob_create.mdxa stray closing**sits after "Failed jobs history limit", where the sibling bullet one line above ends "Successful jobs history limit (default: 20)" with no such marker.Both are also the source of the same defect in the Russian pages, which reproduced the broken markup faithfully. Changing the English updates their
sourceSHA, so the translations are regenerated on the next run and the defect goes with them.Verified: with these six fixed,
doom lintover this repository reports 0 errors — including under the two new rules, which report 5 findings onmasteras it stands.The translations are updated to match in
auto-translations/container_platform!1.