Skip to content

Feature/version i11n switching#78

Open
krumware wants to merge 16 commits intomainfrom
feature/version-i11n-switching
Open

Feature/version i11n switching#78
krumware wants to merge 16 commits intomainfrom
feature/version-i11n-switching

Conversation

@krumware
Copy link
Member

@krumware krumware commented Mar 16, 2026

Major updates to website framework to improve translation management and artifact version selection/switching.

  • .gitignore fix — the resources pattern was matching content/*/resources/, hiding translated resource pages from the sidebar. Changed to /resources to only match Hugo's build output directory.
  • Sidebar translation improvements — sidebar now shows translated titles when available and links to language-prefixed URLs for untranslated pages, keeping users within their language context instead of silently redirecting to English.
  • Translation fallback with CTA — untranslated pages now fall back to English content with a "Translation Needed" banner encouraging contributions. Banner text uses Hugo i18n strings so it can be localized later.
  • Translation stubs for all pages — every translatable page now has a frontmatter-only stub (with outdated: true) in each language directory, so nothing returns a 404.
  • Document versioning structure — versioned resources follow a latest/ + v1/ folder structure with version switcher support. Version tagging instructions added to the README, emphasizing the use of git mv to preserve file history.
  • German language support — added de language config and restored a previously deleted German glossary translation from git history.
  • /en/ path redirect — Netlify redirect from /en/* to /:splat so English content works via /en/-prefixed URLs.
  • Cleanup — removed empty legacy wgs/ directories left over from the TAG App Delivery restructure.

Workflow changes

  • Adding new pages: new translatable pages should include a stub file (outdated: true, frontmatter only) in each language directory so the fallback works.
  • Tagging document versions: use git mv + restore to preserve history when creating a new version folder. See the README section "Tagging a new version of a whitepaper or artifact" for the full process.
  • Finding untranslated content: contributors can look for files with outdated: true and no body content to find pages that need translation.

Do not merge without approvals/reviews

@netlify
Copy link

netlify bot commented Mar 16, 2026

Deploy Preview for cnpe ready!

Name Link
🔨 Latest commit 430e60f
🔍 Latest deploy log https://app.netlify.com/projects/cnpe/deploys/69b970c664d9530008625c3b
😎 Deploy Preview https://deploy-preview-78--cnpe.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

@Okabe-Junya Okabe-Junya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your great work!
let me review based on this discussion - #73 (comment) :)

I think totally LGTM, left some minor comments, PTAL when you have time

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems ko, fr glossary/whitepaper files didn't change the name in this PR and this occurs 404 maybe

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least page is working well in the PR preview

Image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, that's definitely broken. it's supposed to fall back to english content, but even the english one is missing now. i'll inspect.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ready for recheck

{{ $versioned = $versioned | append . }}
{{ end }}
{{ end }}
{{ $sorted := sort $versioned "version" "desc" }}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version switcher idea is so nice!
but seems this will potentially cause like

v1 -> v10 -> v2 -> ... -> v9

(since these versions are "string")

so need to fix in the future (no need to fix for now, but need to fix by releasing v10 I think)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll take a look and make sure. It's intended to be SemVer compatible.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

going to do this in a future PR i think. lots of changes in this one already

<i class="fas fa-language"></i>
</div>
<div class="translation-needed-content">
<strong>Translation Needed</strong>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should support l10n like this:

Suggested change
<strong>Translation Needed</strong>
<strong>{{ i18n "translation_needed_title" }}</strong>

(and update each website/i18n/.toml)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah good call!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ready for recheck

Signed-off-by: Colin Griffin <colin@krum.io>
Signed-off-by: Colin Griffin <colin@krum.io>
…ions

Signed-off-by: Colin Griffin <colin@krum.io>
Signed-off-by: Colin Griffin <colin@krum.io>
Signed-off-by: Colin Griffin <colin@krum.io>
Signed-off-by: Colin Griffin <colin@krum.io>
Signed-off-by: Colin Griffin <colin@krum.io>
Signed-off-by: Colin Griffin <colin@krum.io>
@krumware
Copy link
Member Author

@Okabe-Junya I pushed some additional changes. lots of stuff, but we should have full language parity now, with fallback to english versions where now translations exist (yet).

- Do you have any questions for us?
- Legal Reminder: Only the anonymized transcript will be shared with the wider research team; all references to you and your company will be removed. Only a small group of leads will have access to the video to ensure the integrity of the transcript for the duration of the project, after which the video will be deleted.
- Join the conversation: "Join the ongoing conversation at TAG App Delivery: https://tag-app-delivery.cncf.io/wgs/platforms/"
- Join the conversation: "Join the ongoing conversation at TAG App Delivery: https://cloudnativeplatforms.com/"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

References TAG APP Deliver - and should this point at the TCG?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants