-
-
Notifications
You must be signed in to change notification settings - Fork 118
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
add a way of warning users that localised docs might be out of date #1504
Conversation
✅ Deploy Preview for eclipsefdn-adoptium ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@xavierfacq I've run out of time to work on this one but feel free to take it over if you have time |
Codecov Report
@@ Coverage Diff @@
## main #1504 +/- ##
=======================================
Coverage 99.19% 99.20%
=======================================
Files 87 87
Lines 6467 6504 +37
Branches 550 554 +4
=======================================
+ Hits 6415 6452 +37
Misses 52 52
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Thinking out loud here, we should probably show a similar warning to users if they are being served an English document (because their locale doesn't exist) E.g encouraging users to translate the asciidoc document. |
I take a look at two points:
|
Co-authored-by: Hendrik Ebbers <[email protected]>
Description of change
I've been trying to come up with the best way to help keep localized documentation up to date. For now this seems like a good option that ties the localized document to a specific git sha of it's English counterpart. That way when an English doc is updated, the following warning bar will show to users on localized pages until someone from our localization effort is able to verify if the documentation needs changing.
Checklist
npm test
passes