TRANSLATE THIS
`) should be fine. Testing is VERY important, so do NOT skip it. If during testing, the page appears different from the original English page (besides the translated text, of course), you did something wrong and may have to start again. #### 3.1. Notes for Moneropedia Entries Moneropedia entries have two specificities: * The Front Matter: Moneropedia Fron should be translated for both *entry:* and *summary:* elements. However, *terms:* should be extended with their translation, leaving the English words **untouched**. This is really important for compatibility purposes. With this, if a new guide is added to the site, an English term on the untranslated version of the guide in another language could be linked to the moneropedia article (of the same language). * The snippet keeping track of the status of the translation must be updated (`{% include disclaimer.html translated="no" translationOutdated="no" %}`). If the document is translated, change `translated="no"` to `translated="yes"`. If the document is translated, but the original file (in English) was updated, change `translationOutdated="no"` to `translationOutdated="yes`. Finally, your entry should go from: ``` --- entry: "Entry name in English" terms: ["English", "terms"] summary: "English summary." --- {% include disclaimer.html translated="no" translationOutdated="no" %} ``` To: ``` --- entry: "Translated entry name" terms: ["English", "terms", "translated", "terms"] summary: "Translated summary." --- ``` #### 3.2. Notes for user guides screenshots User guides can contain screenshots. By default they are all displayed in English, but a complete localized user guide should have translated screenshots as well. Screenshots cannot be translated as text obviously, so the only viable solution is to take the same screenshot as the one in the English version, but using the language of the guide you want to update. For example, if the user guide `How to solo mine with the GUI` is translated into French and you want to have the screenshot translated, follow these steps: 1. Go to `/img/resources/user-guides` 2. If this is the first localized screenshot for that language, you'll need to create a dedicate folder with the code of that language. In this example we'll use `fr`. 3. Copy the folder containing the screenshots of the guide you are working on from inside the `en` folder. In this example you have to copy `solo_mine_GUI` into `fr` 4. Now take a look at the screenshots inside `solo_mine_GUI` and replace them with screenshots of the GUI in French. 5. Edit the path of the images in the markdown file which contains the guide. Remember that by default all guides point to the English version, so everything you'll have to do is to change the path of the screenshot and replace `en` with your language code. In our example, we need to navigate to `/_i18n/fr/resources/user-guides/solo_mine_GUI.md` and change the path of all screenshots from `/img/resources/user-guides/en/remote_node/SCREENSHOT.png` to `/img/resources/user-guides/fr/remote_node/SCREENSHOT.png`. ### 4. set the 'translated' snippet to true Somewhere on the page (usually the top) should be a snippet that says `{% include disclaimer.html translated="false" version=page.version %}`. Simply change this to `{% include disclaimer.html translated="true" version=page.version %}`. This will remove the orange bar from the bottom saying the page is untranslated. ## How to add a new language Adding a new language can be complicated. If you feel unsure about the steps necessary, contact the Website workgroup and somebody will add the new language for you. ### 1. \_config.yml file Navigate to the root folder of the whole website and find the file labeled `_config.yml`. Open it and find the line that says `languages:`. Add your two letter language code (Google it if you don't know it) in between the brackets after the others already present. You will need to put a comma after the previous last one. Example: ``` languages: ["en", "es", "NEW LANG HERE"] ``` Save and exit the file. ### 3. \_i18n folder Navigate to the \_i18n folder and duplicate the en.yml file. Rename the duplicate to the two letter language code of your language with a `.yml`. Now duplicate the `en` folder and rename it with the correct language code. **The original folder and yml file themselves should still be there. They should not be renamed. There should be a new folder and yml file in addition to the ones that were already there.** ### 4. Open an issue on the repo where the website is hosted After you've done all the above, you'll need to [open an issue on the repository](https://github.com/monero-project/monero-site/issues) asking to add the language you are working on to Weblate, where the core of the website is translated. ## Housekeeping ### GitHub Issues We ask that if you open an issue on the site that you remain available for clarifying questions or corrections. We do our best to close issues that are resolved when we make changes to the site, but If your issue is resolved by a contributor and the issue is not closed we ask that you close it in a timely manner. A contributor may ask you to close an issue after it's confirmed fixed. Please review the changes to the site and close your issue if you can verify that it's fixed. ### Reviewing Process When a pull request suggesting changes is opened, it will be merged only once it will be reviewed (with some exceptions, like binaries and hashes updates). The process to review a PR is simple: 1. Go through the suggested changes and check that everything is fine and nothing is broken. We have multiple tools that make this process easier: Netlify's previews, which will show a preview of how the website will look like once the PR is merged; GitHub's checks, which will try to build the PR and will say if there were errors during the process. 2. if you think something should be changed, comment on the interested lines, stating clearly what changes you suggest and why. GitHub gives [a set of useful tools](https://github.com/features/code-review/) to make code review easier for both authors and reviewers. 3. When you think the PR is ready to be merged, use GitHub's native "Approve" option, or write a comment explicitly stating your approval. Some common ways to approve a PR is by writing: *ACK/uTACK*, *Reviewed* and *LGTM (Let's Get This Merged)*. Doesn't matter what wording you use, just make your approval clear. 4. In the case you wish a PR doesn't get merged for some reason, make it known by using clear wording. A common way to show disapproval is by writing *NACK (Not Acknowledged)*. NACKing a PR should be accompanied by a detailed explanation of why that PR should be refused. Some pull requests may be labelled `Needs Review`, these PR are prioritary and should be reviewed as soon as possible. ## Updates on User Guides User guides and developer guides may need regular updates, either to fix typos, to add explanations regarding new features, to update screenshots, and so on. As those guides are translated in several languages, it could be hard to keep all languages version up to date with the English version. To keep track of those changes, the user guides (but not the developer guides) are versioned using a snippet at the top of each localized (\_i18n/en/resources/\*-guides) file: ``` {% include disclaimer.html translated="no" translationOutdated="no" %} ``` This snippet is responsible for keeping track of the language version. If the guide is translated, change `translated="no"` to `translated="yes"`. if the page is translated, but something changed in the original guide in English, change `translationOutdated="no"` to `translationOutdated="yes"`. The based version (English version) is however also tracked in the `Front Matter` from the /resources/user-guides/ directory file: ``` outdated: False ``` If the guide is outdated, simply change `False` into `True`. When you update a guide, you are responsible for updating this version tracking in every file involved in your update. Don't be afraid to ask for help if the process is not clear to you. The screenshots of all user guides are in `/img/user-guides/LANG`. Where `LANG` can be any of the languages supported by Getmonero. By default, all localized versions of the website will use the English version of the screenshots, see the [translations](#translation) section for info about translating screenshots. ## How to make a blog post ### 1. Make a file Navigate to the \_posts folder of the website and make a new file. Be sure the file name has no spaces and the ending is .md. Take a look at the other posts to get an idea of how to name yours ### 2. Front Matter ``` --- layout: post title: CHANGE TO YOUR TITLE summary: A BRIEF ONE OR TWO SENTENCE SUMMARY tags: [CHOOSE, RELEVANT, TAGS, AND, SEPARATE, THEM, BY, COMMAS, KEEP, THE, BRACKETS] author: YOUR NAME OR HANDLE HERE --- ``` If you want to add a personalized picture to a blog post that will show as logo on social networks, add `image: /blog/assets/$FOLDER/$IMAGE` to the front matter. Where `$FOLDER` is the name of the folder you created to contain the image related to your blog post and `$IMAGE` is the name of the image. ### 3. Write After the front matter is finished you are free to write the remainder of your blog post in markdown. ## How to make a User Guide ### 1. Quick Start * Create file in /resources/user-guides with an .md ending and no spaces in filename. * Create file in /\_i18n/en/resources/user-guides with the exact same filename as above ending in .md * Write User Guide * Add versioning snippet * Copy User Guide file to ALL LANGUAGES in /\_i18n/[ALL LANGUAGES]/resources/user-guides * set translation to false in the snippet the top of each language version of your User Guide, except the original language * Add guide using markdown in the correct category, and in alphabetic order, in ALL LANGUAGES to /\_i18n/[ALL LANGUAGES]/resources/user-guides/index.md being careful not to mess with any indentation * Test/Build * Submit PR ### 2. Make a file Navigate to the /resources/user-guides folder and make a new file. Be sure the file name has no spaces and the ending is .md ### 3. Content of file ``` --- layout: user-guide title: TITLE OF YOUR USER GUIDE permalink: /resources/user-guides/NAME-OF-FILE-GOES-HERE.html outdated: False --- {% tf resources/user-guides/NAME-OF-FILE-GOES-HERE.md %} ``` Copy this exactly and merely change the files names where indicated. ### 4. Create file in localization folders Navigate to the /i18n/ folder and choose the correct folder for your language. Navigate further into the `resources/user-guides` folders and make a .md file with the EXACT SAME filename as the you made before. ### 5. Write Write your user guide. Be succinct but thorough. Remember, people will be using your guides when they need help. Make sure all the information is there. Feel free to use images or screenshots if necessary to help get your point across. There should be NO front matter on this file. Add the snippet monitoring the status of the translations at the top of your guide: ``` {% include disclaimer.html translated="no" translationOutdated="no" %} ``` If you are copying the structure of another guide, the snippet will be already there with the default value (`no` and `no`. Meaning the guide is not translated) ### 6. Copy User Guide file into all languages Copy your file and navigate to each language file in the /i18n folder. In each language folder go to the resources/user-guides folder and paste your user guide (don't worry, you don't have to translate it) there. This is very important, and the site will not build if the file with the same name is not in each language folder. As you paste into each folder, open up the file and make sure the snippet at the top of the file is correct: `{% include disclaimer.html translated="no" translationOutdated="no" %}`. ### 7. Add Guide to the 'User Guide' landing page of EACH LANGUAGE In the /\_i18n/[ORIGINAL LANGUAGE OF USER GUIDE]/resources/user-guides folder, find the file labeled index.md and open it. DO NOT CHANGE ANYTHING IN THIS DOCUMENT BESIDES WHAT YOU ARE INSTRUCTED TO. This file will look quite different because it's HTML. Don't panic. Simply Ctrl + F (i.e. the find feature) and search for the category that you want to put your User Guide in. You will see there are some sections that are not indented like the others. They are flush with the left side of the screen. **Do not change the indentation.** You can put markdown in these areas. Once you've identified the non-indented area under the category you would like your User Guide to be under, you can use markdown to insert your link with the others in alphabetic order. `[TITLE OF USER GUIDE]({{site.baseurl}}/LINK-TO-USER-GUIDE.html)`. Please note that the file name in between the parentheses must be EXACTLY the same name as the permalink you made in step 5.3, but with a `.html` at the end instead of `.md` and the snippet `{{site.baseurl}}/` before the link. In the event that you think your User Guide should be in a new Category that doesn't exist yet, contact the Website workgroup. Repeat the above process for each language version of this index page. ## How to make a Moneropedia Entry ### 1. Make a Global file Navigate to the /resources/moneropedia folder and make a new file. Be sure the file name has no spaces and the ending is .md Fill this file with this exact content: ``` --- layout: moneropedia title: titles.moneropedia entry: moneropedia.entries.ENTRY --- @moneropedia_article {% t global.lang_tag %} {% tf resources/moneropedia/account.md %} ``` Where `ENTRY` is a one word identifier for the title/name of your Moneropedia entry. For example, if you are adding a new Moneropedia entry called "Daemon", it can be `moneropedia.entries.daemon`. ### 2. Make the localized File Navigate to the /\_i18n/en/resources/moneropedia folder and make a new file. give it the same{% t library.PLACEHOLDER-NAME %}
``` Where `LINK-TO-PUBLICATION` is the URL of the actual publication. If it's a resource external to Getmonero, simply add the URL (for example `https://masteringmonero.com/free-download.html`). If you uploaded the file in the `/library` folder as explained in step 1, use this structure: `{{ site.baseurl_root }}/library/NAME-FILE`. `PLACEHOLDER-NAME` needs to be a placeholder that will be added in the `_18n/en.yml` file, under the `library` category, as explained in the next step. ### 3. Add placeholder in en.yml After you found the `library` category, add your placeholder and value after the last entry of the list. For example: `mypublication: "This is the description of my publication"`. In this example `mypublication` is the placeholder and needs to be also added to the entry in `index.md`, the result will be `{% t library.mypublication %}
` and the value contained in the placeholder will be correctly displayed. Save the changes.