Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[i18n] Enforce explicit heading IDs #6370

Open
3 tasks
chalin opened this issue Feb 18, 2025 · 0 comments
Open
3 tasks

[i18n] Enforce explicit heading IDs #6370

chalin opened this issue Feb 18, 2025 · 0 comments
Assignees
Labels
CI/infra CI & infrastructure enhancement New feature or request i18n Internationalization and localization

Comments

@chalin
Copy link
Contributor

chalin commented Feb 18, 2025

Originally posted by @chalin in #6134 (comment)

... Let's consider this error:

  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#file-names

It says that the file in the PR doesn't have an heading ID named file-names, which is true. For guidance, see:

Some things are beyond the current capabilities of our fix commands. For example, our fix commands don't add heading IDs at the moment (though I'm thinking of doing so as soon as I can). I hope this helps clarify what is going on.

Not having heading IDs created at the same time as new non-en pages are added seems to lead to confusion for some contributors, and sometimes leads to link failures later, when a heading ID becomes referred to for the first time in the en docs (and this gets propagated, via fallback pages) to the non-en docs.

Tasks

  • Somehow enforce explicit heading IDs (maybe via a markdownlink rule) for non-en pages
  • Update the Localization docs to reflect this requirement
  • ...
@chalin chalin added enhancement New feature or request CI/infra CI & infrastructure i18n Internationalization and localization labels Feb 18, 2025
@chalin chalin self-assigned this Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure enhancement New feature or request i18n Internationalization and localization
Projects
None yet
Development

No branches or pull requests

1 participant