Thanks for your help translating the HappyShield website and instructions!
We hope to translate the following files in this website (XX is the ISO 639-1 code for the language):
* index_XX.md (Homepage)
* Instructions/HandCreasing/handCreasing_XX.md (Hand creasing method instructions)
* Instructions/LaserCut/laserCut_XX.md (Laser-cut method instructions)
* Instructions/LaserCutAndPressureCreasing/laserCutAndPressureCreasing_XX.md (Laser-cut and pressure-creasing method instructions)
* Instructions/WaveShield/waveShield_XX.md (WaveShield production method instructions)
Here's how to contribute translations!
- Create a free GitHub account. (If you sign up using an academic email address you are eligible for a free 2-year upgrade to GitHub Pro, but this is not necessary for creating and editing translations to happyshield.github.io).
- Navigate to this repository, making sure that you are viewing the main version of the repository: "HappyShield/happyshield.github.io"
To translate (or edit an existing translation):
Watch our video explaining how to create and edit translations files for HappyShield.Github.io here!
The instructions are also shown below:
- Navigate to the relevant file in this repository.
- Click "Edit this File"
- Type any changes you would like to make to the text in the file.
- Add a description explaining the changes you have made.
- Commit the changes ("Propose File Change")
You can also see this process explained nicely here! https://guides.github.com/activities/hello-world/#commit
- Navigate to the English version of the file (for example:
Instructions/HandCreasing/handCreasing_EN.md
) which you will be translating into another language. - Click the edit button.
- Select all of the text in the file and copy it.
- Close the file. You should have made no changes, so no commit is necessary.
- Navigate to the folder where the file should exist.
- Click create new file, and choose the appropriate name:
Instructions/HandCreasing/handCreasing_TR.md
for "Hand Creasing" instructions in Turkish (TR), for example. - Paste.
- Edit this text, replacing English with your translated text.
- If you want to save your progress at any point, commit the changes, and provide a description of the changed made since the previous commit.
When you are ready for your work to be incorporated into the main repository, you will submit a pull request, which is a request to have these changes incorporated into the live website.
The instructions are also shown below:
- Click Pull Request.
- Click Create Pull Request
- Add any helpful description along with your Pull Request to explain to others what you have added or changed to the text.
- Submit your Pull Request.
Auri (or whoever is managing the repository!) will review and approve the pull request, and then merge these into the main repository, where they should be rendered on the live website within 3-5 minutes. : )