Add section on documentation translations

54J4N · Sep 9, 2015 · e9712e2 · e9712e2
1 parent ce49bba
commit e9712e2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -29,6 +29,7 @@ possible with your report. If you can, please include:
 * Include screenshots and animated GIFs in your pull request whenever possible.
 * Follow the CoffeeScript, JavaScript, C++ and Python [coding style defined in docs](/docs/development/coding-style.md).
 * Write documentation in [Markdown](https://daringfireball.net/projects/markdown).
+  See the [Documentation Styleguide](/docs/styleguide.md).
 * Use short, present tense commit messages. See [Commit Message Styleguide](#git-commit-messages-styleguide).
 
 ## Styleguides

diff --git a/docs/styleguide.md b/docs/styleguide.md
@@ -27,6 +27,21 @@ These are the ways that we construct the Electron documentation.
  - ```### `method(foo, bar)` _OS X_```
 - Prefer 'in the ___ process' over 'on'
 
+### Documentation Translations
+
+Translations of the Electron docs are located within the `docs-translations`
+directory.
+
+To add another set (or partial set):
+
+- Create a subdirectory named by language abbreviation.
+- Within that subdirectory, duplicate the `docs` directory, keeping the
+  names of directories and files same.
+- Translate the files.
+- Update the `README.md` within your language directory to link to the files
+  you have translated.
+- Add a link to your translation directory on the main Electron [README](https://github.com/atom/electron#documentation-translations).
+
 ## Reading Electron Documentation
 
 Here are some tips for understanding Electron documentation syntax.