vue-chartjs icon indicating copy to clipboard operation
vue-chartjs copied to clipboard

Translate Documentation

Open apertureless opened this issue 7 years ago • 10 comments

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!

apertureless avatar Aug 09 '18 08:08 apertureless

of course I will help translating Japanese 👍

euledge avatar Sep 23 '18 01:09 euledge

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!

guillecro avatar Sep 24 '18 17:09 guillecro

Seems the docs are offline.

Uncaught ReferenceError: docute is not defined

vinayakkulkarni avatar Oct 03 '18 04:10 vinayakkulkarni

@vinayakkulkarni

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

apertureless avatar Oct 03 '18 09:10 apertureless

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

apertureless avatar Oct 20 '18 11:10 apertureless

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

apertureless avatar Nov 07 '18 11:11 apertureless

Still looking for help for translations and improvements! 🍺

apertureless avatar Sep 26 '19 07:09 apertureless

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

rakvium avatar Oct 01 '19 17:10 rakvium

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.

jotasies avatar Oct 26 '20 14:10 jotasies