Skip to content

Commit

Permalink
Add translation guide (nushell#413)
Browse files Browse the repository at this point in the history
  • Loading branch information
hustcer committed Apr 22, 2022
1 parent 92fb0ac commit 9cf05cf
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,20 @@ This website is based on Vuepress.

## Running Vuepress locally

1. [Install Node.js](https://nodejs.org/en/download/)
1. [Install yarn](https://yarnpkg.com/getting-started/install)
1. Run `yarn vuepress dev`

## Translation Guide

1. First of all, make sure you have installed `node.js`, `yarn`, and then clone the doc repo locally:
`git clone [email protected]:nushell/nushell.github.io.git nu-docs`;
2. Run `yarn install` in `nu-docs` dir after your cloning;
3. Add a book dir(if not exists) for the specified locale in the docs' root folder, say `zh-CN`, and then create a `book` child folder for all your translated documents, and a README.md for the home page of your locale;
4. Modify the vuepress config file `nu-docs/.vuepress/config.js`, add `zh-CN` related configs;
5. Add README.md in the `book` dir, and that will be the default introduction page of Nushell.
6. Run `yarn vuepress dev`, then open **http:https://localhost:8080/** in your browser, switch to the language you are going to translate into, and you will see the introduction page you have just created. You can translate the docs and save them to get a preview in the browser;
7. Update the `nu-docs/i18n-meta.json` file, fill the locale value of the doc you have just finished. It's recommend to use `commit_id@author` or simply a `commit_id` to indicate your translation end to the specified commit;
8. Commit your changes, It's recommend to squash all your commit in one commit with a commit message like this: `Translate your_doc_file.md to zh-CN from commit: f3dc86d3d`;
9. Send a Pull Request;
10. Check outdated translations: You can use command like `nu ./i18n.nu outdated zh-CN` to check the outdated translations(documents have been changed after your last translation) for the specified locale.

0 comments on commit 9cf05cf

Please sign in to comment.