Added localisation support and instructions

LemmyNet · Jan 4, 2021 · 93ede3d · 93ede3d
1 parent 0c98e25
commit 93ede3d
Show file tree

Hide file tree

Showing 27 changed files with 43 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,36 @@
+# Lemmy Documentation
+
+Documentation for the Lemmy project
+
+## Building
+
+You need to have [Cargo](https://doc.rust-lang.org/cargo/) installed.
+
+Our documentation tool [mdbook](https://github.com/rust-lang/mdBook) doesn't support localisation yet, so we are using code that is still work on progress to create our documentation with localisation. Note that this code still has some rough edges. See [github.com/rust-lang/mdBook/pull/1306](https://github.com/rust-lang/mdBook/pull/1306) for more details.
+
+```bash
+cargo install mdbook --git https://github.com/Ruin0x11/mdBook.git \
+    --branch localization --rev d06249b
+# generate static page in `book` subfolder
+mdbook build
+# serve the book at `http://localhost:3000`, and rebuilds on changes
+mdbook serve
+```
+
+## Adding a new Language
+
+- Edit `book.toml` to add the metadata for your language
+- Copy `src/en/SUMMARY.md` to `src/xx/SUMMARY.md` (where xx is your language's identifier)
+- In `src/xx/`, write your translation into files and folders with the same name as in `src/en/`
+- Use the instructions above to ensure that it builds without errors
+
+## Guidelines for adding a new Translation
+
+- After following the instructions above for adding a new language, open a pull request in the repository.
+- We don't expect that you translate the entire documentation as fast as possible, its more important that you consistently work to improve the translation (even if its only a few hours a week or less).
+- The goal is not to make a sentence-for-sentence translation of the English docs, but writing something that addresses the needs of users in your language. For example, if docker-compose docs are lacking in a language, that should be explained more extensively in lemmy docs for that language
+- This is technical documentation, so try to avoid mentioning things that are unrelated to Lemmy itself, and avoid mentioning specific Lemmy instances.
+- Avoid adding files which don't exist in English or other languages, as that would lead to problems when switching between languages.
+- We will merge a new language after it has been worked on regularly for at least a month, and at least some pages are finished.
+- After merging, we will add a label for the language, to help organising issues and pull requests by language.
+- The translator will also get maintainer rights in this repository, to allow managing contributions for their language.
diff --git a/book.toml b/book.toml
@@ -1,6 +1,11 @@
 [book]
 authors = ["Felix Ableitner"]
-language = "en"
-multilingual = false
 src = "src"
+
+[language.en]
+name = "English"
 title = "Lemmy Documentation"
+
+#[language.es]
+#name = "Español"
+#title = "Documentación Lemmy"
diff --git a/src/SUMMARY.md → src/en/SUMMARY.md b/src/SUMMARY.md → src/en/SUMMARY.md
diff --git a/src/about/about.md → src/en/about/about.md b/src/about/about.md → src/en/about/about.md
diff --git a/src/about/features.md → src/en/about/features.md b/src/about/features.md → src/en/about/features.md
diff --git a/src/about/goals.md → src/en/about/goals.md b/src/about/goals.md → src/en/about/goals.md
diff --git a/src/about/guide.md → src/en/about/guide.md b/src/about/guide.md → src/en/about/guide.md
diff --git a/src/about/ranking.md → src/en/about/ranking.md b/src/about/ranking.md → src/en/about/ranking.md
diff --git a/src/administration/administration.md → src/en/administration/administration.md b/src/administration/administration.md → src/en/administration/administration.md
diff --git a/src/administration/backup_and_restore.md → src/en/administration/backup_and_restore.md b/src/administration/backup_and_restore.md → src/en/administration/backup_and_restore.md
diff --git a/src/administration/configuration.md → src/en/administration/configuration.md b/src/administration/configuration.md → src/en/administration/configuration.md
diff --git a/src/administration/install_ansible.md → src/en/administration/install_ansible.md b/src/administration/install_ansible.md → src/en/administration/install_ansible.md
diff --git a/src/administration/install_docker.md → src/en/administration/install_docker.md b/src/administration/install_docker.md → src/en/administration/install_docker.md
diff --git a/src/contributing/contributing.md → src/en/contributing/contributing.md b/src/contributing/contributing.md → src/en/contributing/contributing.md
diff --git a/src/contributing/custom_frontend.md → src/en/contributing/custom_frontend.md b/src/contributing/custom_frontend.md → src/en/contributing/custom_frontend.md
diff --git a/src/contributing/docker_development.md → src/en/contributing/docker_development.md b/src/contributing/docker_development.md → src/en/contributing/docker_development.md
diff --git a/src/contributing/federation_development.md → ...en/contributing/federation_development.md b/src/contributing/federation_development.md → ...en/contributing/federation_development.md
diff --git a/src/contributing/local_development.md → src/en/contributing/local_development.md b/src/contributing/local_development.md → src/en/contributing/local_development.md
diff --git a/src/contributing/tests.md → src/en/contributing/tests.md b/src/contributing/tests.md → src/en/contributing/tests.md
diff --git a/src/contributing/theming.md → src/en/contributing/theming.md b/src/contributing/theming.md → src/en/contributing/theming.md
diff --git a/src/contributing/websocket_http_api.md → src/en/contributing/websocket_http_api.md b/src/contributing/websocket_http_api.md → src/en/contributing/websocket_http_api.md
diff --git a/src/federation/administration.md → src/en/federation/administration.md b/src/federation/administration.md → src/en/federation/administration.md
diff --git a/src/federation/federation.md → src/en/federation/federation.md b/src/federation/federation.md → src/en/federation/federation.md
diff --git a/src/federation/lemmy_protocol.md → src/en/federation/lemmy_protocol.md b/src/federation/lemmy_protocol.md → src/en/federation/lemmy_protocol.md
diff --git a/src/federation/overview.md → src/en/federation/overview.md b/src/federation/overview.md → src/en/federation/overview.md
diff --git a/src/federation/resources.md → src/en/federation/resources.md b/src/federation/resources.md → src/en/federation/resources.md
diff --git a/src/lemmy_council.md → src/en/lemmy_council.md b/src/lemmy_council.md → src/en/lemmy_council.md