Skip to content

Copy untranslated english pages to other languages #1961

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

Merged
merged 23 commits into from
Aug 7, 2019

Conversation

bahmutov
Copy link
Contributor

@bahmutov bahmutov commented Aug 6, 2019

  • removes untranslated Japanese pages
  • removes untranslated Chinese pages

Instead looks at the Git information to find English pages without corresponding checked in fully translated file, and copies the English file as a pre-build step (called from index.js that runs Hexo)

@cypress
Copy link

cypress bot commented Aug 6, 2019



Test summary

31 1 0 0


Run details

Project cypress-documentation
Status Failed
Commit f2763a8
Started Aug 6, 2019 3:12 AM
Ended Aug 6, 2019 3:13 AM
Duration 01:11 💡
OS Linux Debian - 9.9
Browser Electron 61

View run in Cypress Dashboard ➡️


Failures

cypress/integration/page_header_spec.js ⏯ Failed
1 Page Header > displays correct page title

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

The Japanese docs did have the title translated, so this ends up blowing out the translated title - which is why this test is failing.

I've been going back and forth a bit on these titles. TBH, it's a duplicate that's uneccesary - the title is already defined in the relevant en.yml, ja.yml and is the title that should show at the top of the page.

On the other hand, I feel like removing the title from the meta-data makes it a little bit confusing about which file you're editing??? I don't know. We should probably just remove the title from the meta-data.

@bahmutov
Copy link
Contributor Author

bahmutov commented Aug 6, 2019

yeah, I don't think titles in each Markdown document matter - I usually know which document I am editing from the filename itself displayed on top of the document. I would not count just titles there as translations. Continuing with Chinese docs.

@bahmutov
Copy link
Contributor Author

bahmutov commented Aug 6, 2019

I have removed the rest of the duplicates, and have updated the test to not look at the translated doc titles.

@jennifer-shehane
Copy link
Member

Yeah, I am suggesting just removing the metadata at the top of the pages - and using the defined titles in the relevant en.yml, ja.yml doc, which are all translated.

@bahmutov
Copy link
Contributor Author

bahmutov commented Aug 7, 2019

@jennifer-shehane I think removing the meta-data title on each page and fetching it from the language.yml is good idea - just needs to be a separate work, since it is a little bit tricky

@bahmutov bahmutov merged commit a1b713a into develop Aug 7, 2019
@jennifer-shehane
Copy link
Member

jennifer-shehane commented Aug 8, 2019

I really wish I had been given time to review this before merging in.

I tried writing some partial new info to a translated file (as is common), and am running into an issue with lint because the entire /zh-cn and /ja files are in .gitignore?

How does someone commit any translations to these actual translated docs if they are ignored?

My use case is that I am adding some new wording to the installing-cypress doc in english - which is translated into chinese, so I just add the new note in English to the chinese doc so that it still stays up to date. https://github.com/cypress-io/cypress-documentation/pull/1978/files#diff-1a4028ad956dff4662e881bf8c9bc37dR73

@matthamil matthamil deleted the copy-untranslated-english-pages-to-other-languages branch April 14, 2021 19:43
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.

2 participants