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

I know another language, and would love to contribute! #602

Closed
wataruoguchi opened this issue May 18, 2018 · 7 comments · May be fixed by novalina26/cypress-documentation#6
Closed

I know another language, and would love to contribute! #602

wataruoguchi opened this issue May 18, 2018 · 7 comments · May be fixed by novalina26/cypress-documentation#6
Assignees

Comments

@wataruoguchi
Copy link
Contributor

Hi cypress team!

Thank you for building this project! I lately started using cypress, and I love it. porting from selenium is easy, APIs are well designed, and most importantly, it's fast 🚀
I'd like to translate the docs in Japanese if it's helpful for the community. I'm wondering where to create translated md files, and how you integrate that.
As I see md files under source/, it'd be under source/ja/ or something?

Let me know if you have any particular guideline for translation, or if not I'm happy to collaborate.

@jennifer-shehane
Copy link
Member

Yay! 🙌

Yes, there would need to be some slight updates and tests done on our part, as I just put off doing the work until there was another language. But, I will update this as soon as there are translated files submitted.

screen shot 2018-05-18 at 9 53 41 am

Our internationalization structure is based off of how hexo generated their own documentation, if that repo helps at all: https://github.com/hexojs/site/tree/master/source

Let me know if you have any more questions.

@wataruoguchi
Copy link
Contributor Author

@jennifer-shehane Thanks for the advice.
How are you building this?
After running npm i && npm run build I am seeing a lot of 400/500 errors

disabling filter cleanup for environment development                                               
in environment development site url is https://docs.cypress.io                               
NODE_ENV is: development                                            
INFO  Start processing                                                                      
StatusCodeError: 500 - ""                                            
    at new StatusCodeError (/<somewhere>/cypress-documentation/node_modules/request-promise-core/lib/errors.js:32:15)
    at /<somewhere>/cypress-documentation/node_modules/request-promise-core/lib/plumbing.js:97:41
    at runCallback (timers.js:773:18)             
    at tryOnImmediate (timers.js:734:5)    
    at processImmediate [as _immediateCallback] (timers.js:711:5)
From previous event:                    
    at Request.plumbing.init (/<somewhere>/cypress-documentation/node_modules/request-promise-core/lib/plumbing.js:36:28)
    at Request.RP$initInterceptor [as init] (/<somewhere>/cypress-documentation/node_modules/request-promise-core/configure/request2.js:41:27)
    at new Request (/<somewhere>/cypress-documentation/node_modules/request/request.js:128:8)
    at request (/<somewhere>/cypress-documentation/node_modules/request/index.js:53:10)
    at validateExternalUrl (/<somewhere>/cypress-documentation/lib/url_generator.js:118:10)
    at keyv.set.then (/<somewhere>/cypress-documentation/lib/url_generator.js:294:16)
    at <anonymous>                                     
    at process._tickCallback (internal/process/next_tick.js:160:7)

@jennifer-shehane
Copy link
Member

Yes 😬

We have a process that checks every single url throughout the site to ensure they are working urls. Some of the urls appear to be returning 404 and 500 without a stack trace to know which url it was, so I haven't been able to track down where they are coming from. There's an open issue here #197

You should be able to ignore these (unless you know how to fix them! 😄) and it will still successfully build. If you are running npm start you will eventually see:

INFO  Hexo is running at http://localhost:2222. Press Ctrl+C to stop.

@wataruoguchi
Copy link
Contributor Author

My machine is not a great environment for building this Hexo project. Super slow. I hope somebody else to continue this translation.

@jennifer-shehane
Copy link
Member

jennifer-shehane commented Jun 14, 2018

Yeah, it is a bit clunky at the moment.

Some notes on things I need to do:

  • Add tests for language selection
  • Update tests to not use static themes/cypress/languages/en.yml
  • Link to 'edit' doc should go to corresponding language dir
  • Document/build process around updating English docs -> updating translated equivalent.
  • Have sidebar/all links go to corresponding language dir

@brian-mann
Copy link
Member

npm start -- --no-validate will skip all of those initial URL checks. The docs are in bad need of an upgrade to rework a lot of internal stuff.

@jennifer-shehane
Copy link
Member

Closing due to inactivity.

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

Successfully merging a pull request may close this issue.

3 participants