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] Make instrumentation-intro shortcode a simple include #6364

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Feb 18, 2025

  • Contributes to Improved i18n support #4467
  • Converts the instrumentation-intro.md shortcode into a regular markdown file, included via the new includes shortcode. This way we can enable all the regular text, markdown, and i18n checks (for drift etc.). This is done for the following languages that had a instrumentation-intro.md shortcode:
    • en
    • es
    • pt
  • There is no change in the generated site files where we switched to using include instead of a shortcode.
  • We do have the interesting side-effect that English fallback pages with an include of instrumentation-intro.md will be populated with the locale's version of the include. Is this ok with you @open-telemetry/docs-es-approvers @open-telemetry/docs-pt-approvers? It might be a bit strange (and we might need to modify the page-not-translated banner text), but I think that this is be best way moving forward.
    • (If we agree to edit the page-not-translated text, I'll do that in a followup PR. I'd probably just add a qualifier like: "... not yet been fully translated ...") (I've added the qualifier "fully" to the banner text in this PR.)
  • Updates /xx/_includes with:
    • A section index so that we can ensure that no page is generated for any includes, including the section itself

Preview:

@chalin chalin added cleanup/refactoring i18n Internationalization and localization labels Feb 18, 2025
@chalin chalin requested a review from a team as a code owner February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested review from a team February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested a review from a team February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested a review from a team February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested a review from a team February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested a review from a team February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested a review from a team February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested a review from a team February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested a review from a team February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested review from a team and removed request for a team February 18, 2025 00:11
@opentelemetrybot opentelemetrybot requested review from mx-psi and a team February 18, 2025 00:11
@chalin chalin force-pushed the chalin-im-refactor-shortcodes-for-i18n-2025-02-17 branch 2 times, most recently from 8c06808 to a97823d Compare February 18, 2025 00:40
@chalin chalin force-pushed the chalin-im-refactor-shortcodes-for-i18n-2025-02-17 branch from f89f21e to ed6f3b1 Compare February 18, 2025 03:59
@opentelemetrybot opentelemetrybot requested review from a team February 18, 2025 03:59
@chalin
Copy link
Contributor Author

chalin commented Feb 18, 2025

Thanks for the review @cartermp.
Since this is a simple "refactoring", I'll merge now. SIG comments are still welcome.

@chalin chalin merged commit 5afa723 into open-telemetry:main Feb 18, 2025
18 checks passed
@chalin chalin deleted the chalin-im-refactor-shortcodes-for-i18n-2025-02-17 branch February 18, 2025 04:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants