Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add translate guide #396

Merged
merged 1 commit into from
Feb 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions docusaurus/docs/help-translate/help-translate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
sidebar_position: 99
---

# Help translate the docs

I'm always looking for people to translate the documentation into different languages.
If you want to help use this guide to help you get started!

## How to translate

## Prerequisites

* `nodejs` installed
* `npm` installed
* `git` installed

## Setup i18n

<!-- markdownlint-disable-next-line -->
* Fork the [https://github.com/thijsvanloef/palworld-server-docker](https://github.com/thijsvanloef/palworld-server-docker) repository
* Clone your created fork.
* Navigate to the `docusaurus` folder.<!-- markdownlint-disable-next-line -->
* Add your locale to the i18n config on line in the [docusaurus.config.js](https://github.com/thijsvanloef/palworld-server-docker/blob/main/docusaurus/docusaurus.config.js)
* Run: `npm run write-translations -- --locale <locale code>`

:::info
After running `npm run write-translations -- --locale <locale code>` a new folder will be created in the `i18n` folder
:::

* Remove the `docusaurus-plugin-content-blog` folder
* Create a `current` folder inside `docusaurus-plugin-content-docs`
* Copy the contents of `docs` to the `current` folder
* Start translating!

## Testing the translation

If you are done translating you can test that version of the site by doing the following:

* Navigate to the `docusaurus` folder
* Run: `npm start -- --locale <locale code>`

## Opening a Pull request
<!-- markdownlint-disable-next-line -->
* Go to [https://github.com/thijsvanloef/palworld-server-docker/compare](https://github.com/thijsvanloef/palworld-server-docker/compare)
* Select your repository/branch
* Press: `Create pull request`