-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Overview
Since we have decided to write all our documentation in English, we need to translate our project site KPI Rover accordingly.
- The site is hosted on GitHub Pages: https://pages.github.com/
- It uses Docusaurus as the static site generator: https://docusaurus.io/
- The content repository is available here: https://github.com/KPI-Rover/KPI-Rover.github.io
Please translate the site into English using ChatGPT or another AI tool while ensuring the translations are accurate, natural, and contextually appropriate.
Workflow
1. Setup Environment
- Get familiar with Docusaurus and install all necessary tools to work locally.
- Ensure your development environment is properly configured.
2. Build the Site Locally
- Follow the instructions in the repository’s README file to build the site locally.
3. Translate Page by Page
- Each translation should be submitted as a separate pull request (PR).
- Create a dedicated branch for each page you translate.
- Use the following naming convention for branches:
<issue-number>-translate-<page-path> Example for page https://kpi-rover.github.io/docs/project/intro : 9-translate-docs/project/intro
4. Quality Assurance
- Ensure that the translated content is grammatically correct and maintains the original meaning.
- If needed, manually refine the AI-generated translations.
- Build site locally and run to make sure that it looks as expected.
5. Submit Pull Requests
- Submit a separate PR for each translated page.
- The following template should be used for PR Subject: Issue Create DoD file with development completion criteria #9: Translate
6. Review and Merge
- The PR must be reviewed and approved by a team member before merging.
- Ensure that there are no breaking changes and that formatting is consistent with the original structure.
7. Verify Deployment
- Once the PR is merged, confirm that the translated page is correctly deployed on GitHub Pages.
- Open the deployed site and check that the page appears as expected.
- If any issues arise, fix them and submit a follow-up PR.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Type
Projects
Status
No status