-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
Provide a per-page outdated notification for localized content #41768
Provide a per-page outdated notification for localized content #41768
Conversation
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
/area web-development |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! It's nice to see this.
Almost LGTM. Can we use a less strong marker than danger
though?
LGTM However: Once you make that change @morix1500, I recommend you squash this down to 1 commit. |
7a7e536
to
a10fce9
Compare
As this stands: The tweak I suggested in #41768 (review) is welcome too; either as a change in this PR, or as a follow up. Thank you @morix1500 |
LGTM label has been added. Git tree hash: 36bcd3dc860ff03cff45388dd78c147d231d9c94
|
/lgtm This PR does what the description says it should. |
LGTM label has been added. Git tree hash: 1d4329e9c871d485ddc10d1ce19a63c062ffed17
|
/area localization |
Thank you @morix1500 for this! This will be extremely helpful. |
This is a nice addition for the website! Thanks for working on this @morix1500 😃 |
I think the files for the Japanese localization were removed but the label wasn't removed. /remove-language ja |
I believe this is a positive addition and a step in the right direction. However, I have identified a potential limitation. Currently, any update made to the localized file modifies the |
A suggestion to address this risk would be to adopt a new front-matter field as a next step that indicates the version of a given page. I imagine it might be undesirable from a broader docs perspective, but a change such as that could allow more reliable checks across localized content. |
Is the lack of a notice a problem? If so, how much? If in future we want to track where a page is up to, I'd record the short ref that the page was last brought fully up to data against. But really we'd love to make localization work simpler, not add effort. |
I love the simplicity of this solution and definitely would not want to make things more complicated. However...
Indeed. Users and localization contributors might misinterpret the missing notice as an indicator that the content is up-to-date, leading to the following unintended consequences:
This is unclear and varies depending on the circumstances.
|
Here is how we update a zh-cn localization page. The localization team reached a consensus about two years ago:
These rules appeared too strict during the first few weeks/months. When the convention There is a secret tool which really helped,
To get an overview of out-dated pages, run:
|
As a side note, I'm not a big fan of adding more banners to the pages. |
@morix1500 |
e688b92
to
7c0d55e
Compare
Love this change and really happy to see how fast the idea was implemented after our recent discussion in Slack. While it is a simple implementation, I fully support it. I think we can think about improving it further after introducing this change to the end users and getting their first feedback. It will be also important to inform all localisation teams about this change and its limitations (the possible |
7c0d55e
to
4fa23bc
Compare
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: reylejano The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
I have implemented a notification on the localization page to alert users that information may be out of date.
issue: #41519
This function is implemented with the following logic
Lastmod
of the currently opened page.Lastmod
of the English version of the page.I am a Japanese speaker and could not configure non-English i18n settings.
If this implementation details are ok, I would appreciate it if you could work with me to come up with messages in other languages :)
DaemonSet._.Kubernetes.mp4