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

add a way of warning users that localised docs might be out of date #1504

Merged
merged 9 commits into from
Sep 12, 2023

Conversation

gdams
Copy link
Member

@gdams gdams commented Feb 14, 2023

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.

Screenshot 2023-02-14 at 12 36 42

Checklist

  • npm test passes
  • documentation is changed or added (if applicable)
  • permission has been obtained to add new logo (if applicable)
  • contribution guidelines followed here

@netlify
Copy link

netlify bot commented Feb 14, 2023

Deploy Preview for eclipsefdn-adoptium ready!

Name Link
🔨 Latest commit 13174d2
🔍 Latest deploy log https://app.netlify.com/sites/eclipsefdn-adoptium/deploys/650032c28b4bd000088c0b6a
😎 Deploy Preview https://deploy-preview-1504--eclipsefdn-adoptium.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 site configuration.

@gdams gdams changed the title add a way to warning users that localised docs might be out of date add a way of warning users that localised docs might be out of date Feb 14, 2023
karianna

This comment was marked as resolved.

@gdams
Copy link
Member Author

gdams commented Sep 8, 2023

@xavierfacq I've run out of time to work on this one but feel free to take it over if you have time

@codecov
Copy link

codecov bot commented Sep 8, 2023

Codecov Report

Merging #1504 (8dc81c5) into main (d9dc3c1) will increase coverage by 0.00%.
Report is 7 commits behind head on main.
The diff coverage is 100.00%.

❗ Current head 8dc81c5 differs from pull request most recent head 13174d2. Consider uploading reports for the commit 13174d2 to get more accurate results

@@           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           
Files Changed Coverage Δ
src/templates/asciidocTemplate.tsx 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@gdams
Copy link
Member Author

gdams commented Sep 8, 2023

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.

@xavierfacq
Copy link
Member

I take a look at two points:

  • Try to pass codecov
  • Add similar warning to users seeing default English document

@gdams gdams enabled auto-merge (squash) September 12, 2023 09:46
@gdams gdams merged commit 51a635f into adoptium:main Sep 12, 2023
9 checks passed
@gdams gdams deleted the outdate branch September 12, 2023 09:48
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.

5 participants