Js-lingui: Documentation proofreading

[tricoder42]

Happy Hacktoberfest!

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Problem

There's a new documentation. However, I'm not a native english speaker and the documentation really needs some external proofreading.

List of pages:

• Tutorials
  
  
  
  • [x] React (@BitYog)
  
  
  • [x] CLI (@BitYog)
  
  
• Guides
  
  
  
  • [x] How plurals work (@ayushgangrade)
  
  
  • [x] Dynamic loading of translations (@ayushgangrade)
  
  
• API references
  
  
  
  • [x] React (@Andrew565)
  
  
  • [x] CLI (@Andrew565)
  
  
  • [x] Configuration (@Andrew565)
  
  
• Releases
  
  
  
  • [x] Migration from 0.x to 1.x (@Andrew565)
  
  

How-to

All documentation is in docs folder. It's build using Sphinx Document Generator and uses reStructuredText.

If you want to build documentation locally, you need to have Python installed.

1. Install pipenv tool:

pip install pipenv

1. Install project dependencies

pipenv install

After making any changes, simply run make html inside docs folder.

cd docs
make html

Support

Need a help? Ping me on gitter. I live in Europe/Prague UTC+2 timezone and most of the time I answer questions on gitter instantly.

[Andrew565]

Getting started on this now. :)

[ayushgangrade]

@tricoder42 I'm also helping !

[tricoder42]

@Andrew565 @ayushgangrade Wow, that was fast! You're awesome, thanks!

I added list of pages to issue description if you would like to split the work.

[Andrew565]

Thanks @tricoder42, I'll get started with the Migration, work bottom-up.

[ayushgangrade]

Cool! I'll start working on the guides! @Andrew565

[ayushgangrade]

@Andrew565 I did some edits for the guides. I'll try to find fixes and additions for tutorials now. Not just grammar edits, more content too!

[Andrew565]

That's it for the API docs, and the last I'm going to be working on this for now. Let me know if any tweaks are needed.

Good luck with your project here, it looks really good. I'll definitely be recommending it to my team when we get around to implementing i18n.

[tricoder42]

@Andrew565 Thank you very much, you really helped me a lot! I'm gonna merge all PRs on 1st October. 🎉

Ping me anytime if you need some help when implementing i18n.

[BitYog]

Hey, @tricoder42. I can help with the React and CLI docs. I'm a native English speaker.

[BitYog]

Hey @tricoder42. I've done the required changes and created a pull request.

[tricoder42]

@BitYog Thank you very much! PR looks awesome! 🎉

[BitYog]

Thanks. I'm a first timer in open source, and I absolutely loved your work
and the way you quickly replied. BTW, got any GitHub tips?

[tricoder42]

@BitYog You mean tips for using GitHub or for interesting projects at GitHub?

For the first, I'm afraid I don't know any secret tips :) I always have to google how to add commits to someone else PR, which is the most advanced thing I've ever done on GitHub :D

Interesting projects at GitHub: depends on what domain are you interested in. I enjoy how some people manage their projects, like @kentcdodds, @erikras, @kennethreitz (I surely forgot somebody).

[BitYog]

Hey,
Are you really merging all the PRs on 1st Oct?

On Sep 30, 2017 11:44 AM, "Tomáš Ehrlich" [e-mail] wrote:

@BitYog https://github.com/bityog You mean tips for using GitHub or for
interesting projects at GitHub?

For the first, I'm afraid I don't know any secret tips :) I always have to
google how to add commits to someone else PR, which is the most advanced
thing I've ever done on GitHub :D

Interesting projects at GitHub: depends on what domain are you interested
in. I enjoy how some people manage their projects, like @kentcdodds
https://github.com/kentcdodds, @erikras https://github.com/erikras,
@kennethreitz https://github.com/kennethreitz (I surely forgot
somebody).

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/lingui/js-lingui/issues/85#issuecomment-333287052,
or mute the thread
https://github.com/notifications/unsubscribe-auth/Aa6XKqlwcoTnY-zasLr5gr170kQapp4Rks5sndwogaJpZM4PosOv
.

[tricoder42]

@BitYog I think I should to count them for #Hacktoberfest. I couldn't find the exact rules online and DigitalOcean didn't replied to one of my tweets.

Rules says:

To get a shirt, you must make four pull requests between October 1–31 in any timezone.

I hope they'll list all PRs on GitHub from October 1st to October 31st.

[BitYog]

👍👍👍

On Sep 30, 2017 12:15 PM, "Tomáš Ehrlich" [e-mail] wrote:

@BitYog https://github.com/bityog I think I should to count them for

Hacktoberfest. I couldn't find the exact rules online and DigitalOcean

didn't replied to one of my tweets.

Rules says:

To get a shirt, you must make four pull requests between October 1–31 in
any timezone.

I hope they'll list all PRs on GitHub from October 1st to October 31st.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/lingui/js-lingui/issues/85#issuecomment-333288455,
or mute the thread
https://github.com/notifications/unsubscribe-auth/Aa6XKqns7OG59bBRbH2yaeRi67iWtzAsks5sneOcgaJpZM4PosOv
.

[kennethreitz42]

Let me know if you run into any pipenv issues!

[tricoder42]

@Kennethreitz I do ;) Thanks for great tool!

[BitYog]

Merging our PRs today???

[tricoder42]

I’ll merge it tonight, I’m afk right now

1. 
   
   1. 2017 v 9:27, Yog Mehta [e-mail]:
   
   

Merging our PRs today???

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

[jenniferabowd]

@tricoder42 Do you still need help with this? If so I'm happy to help once the pull requests have been merged.

[tricoder42]

@jenniferkaplannyc So far it's all reviewed and merged. I'm gonna add more sections to documentation this month. I'll let you know if you were still interested!

@Andrew565 @ayushgangrade @BitYog Thank you guys for great work!