Vue-chartjs: Translate Documentation

Created on 9 Aug 2018  ยท  9Comments  ยท  Source: apertureless/vue-chartjs

So, it took a while but I have rewritten the documentation and ported it to VuePress.
I hope the structure is a bit better and a few more examples.

If you have any suggestions, please feel free to contribute!
And I always need help with translating!

Structure

The new structure is quite simple. The english documentation is under the /docs/ folder.

docs
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ guide
โ”‚   โ””โ”€โ”€ README.md
โ”œโ”€โ”€ reference
โ”‚   โ””โ”€โ”€ README.md

The first README.md is the Landingpage.
Under /guide/ you will find the normal documentation with examples. Under /reference/ you will find some coding references, like public methods, props, events and so on.

Localization

Inside the docs folder you will find the subfolders for localization. For example zh-cn/, ja/, ru/ ... and so on. I've already created the folders and files. So if you want to contribute you only need to translate it inside your folder.

docs
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ reference
โ”‚   โ””โ”€โ”€ README.md
โ””โ”€โ”€ zh-cn
    โ”œโ”€โ”€ README.md
    โ”œโ”€โ”€ guide
    โ”‚   โ””โ”€โ”€ README.md
    โ””โ”€โ”€ reference
        โ””โ”€โ”€ README.md

Checklist for Contributors

  • [ ] Checkout develop
  • [ ] Run yarn docs:dev or npm run docs:dev
  • [ ] Translate Landingpage /README.md
  • [ ] Translate Guide /guide/README.md
  • [ ] Translate API Reference /api/README.md
  • [ ] Translate config.themeConfig.locales /.vuepress/config.js
  • [ ] Translate config.locales /.vuepress/config.js (description field)

Feel free to add additional languages!

Hacktoberfest documentation โœ help wanted

Most helpful comment

@apertureless I'm going to implement the Russian section.

All 9 comments

of course I will help translating Japanese ๐Ÿ‘

Good luck! Thou, have in mind that the doc is retrieving the latest dist of Docute.
I am going to send you a PR with the fixed URLs for the documentation to work properly!

Seems the docs are offline.

Uncaught ReferenceError: docute is not defined

@vinayakkulkarni

Maybe clear your cache.
Docs are working fine after the merged PR from @guillecro

Would be cool if you guys could help translating the new docs! ๐Ÿ™

@zupolgec @amadeann @euledge @kylewelsby @chakan @music-mind @cugu @pushkyn @tesarwijaya @julienc91 @dood- @Mooooooon

New docs are up now: https://vue-chartjs.org/

Still looking for help for translations and improvements! ๐Ÿบ

@apertureless I'm going to implement the Russian section.

Hi all, I'm could give you some help with translation, this will be my first contribution to an open project but I'm sure I can help. I can work on the Spanish translation, in this specific case will be es-cr (Spanish Costa Rica), eventually could be the base for the other variations within Spanish as they could be a very reduce amount of changes from one variation to another.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

humanismusic picture humanismusic  ยท  3Comments

Scalpel78 picture Scalpel78  ยท  4Comments

ihrankouski picture ihrankouski  ยท  3Comments

bdeanindy picture bdeanindy  ยท  3Comments

kurbar picture kurbar  ยท  4Comments