4rkal/monero-site
1
0
Fork 0
mirror of https://github.com/monero-project/monero-site.git synced 2024-12-14 04:16:35 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #619 from prikhi/fix-readme-numbering

Browse Source 
Fix Section Numbering in README
This commit is contained in:
luigi1111 2018-03-01 12:52:41 -05:00 committed by GitHub
commit f754966fd5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -166,13 +166,13 @@ Write your user guide. Be succinct but thorough. Remember, people will be using
The title should be at the top of the User Guide using a single `#` for an H1 tag. Titles will not be automatically put on these pages as with other pages. There should be NO front matter on this file. The title should be at the top of the User Guide using a single `#` for an H1 tag. Titles will not be automatically put on these pages as with other pages. There should be NO front matter on this file.
### 5.5 Copy User Guide file into all languages ### 5.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 (INCLUDING template) 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. Copy your file and navigate to each language file in the /i18n folder. In each language folder (INCLUDING template) 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 paste the following snippet at the top of the file (before your title): As you paste into each folder, open up the file and paste the following snippet at the top of the file (before your title):
`{% include untranslated.html %}`. This does not need to be done in the original language that the User Guide was written in. `{% include untranslated.html %}`. This does not need to be done in the original language that the User Guide was written in.
### 5.6 Add Guide to the 'User Guide' landing page of EACH LANGUAGE ### 5.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. 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. DO NOT CHANGE ANYTHING IN THIS DOCUMENT BESIDES WHAT YOU ARE INSTRUCTED TO.
@ -185,10 +185,10 @@ In the event that you think your User Guide should be in a new Category that doe
Repeat the above process for each language version of this index page INCLUDING THE template. Repeat the above process for each language version of this index page INCLUDING THE template.
### 5.7 Build/Test ### 5.8 Build/Test
Build your website using `jekyll serve` if it's not rebuilding automatically and test that your link appears in the correct category and that it leads to your User Guide when clicked. Test your User Guide in the browser and contact rehrar if there are any bugs. Build your website using `jekyll serve` if it's not rebuilding automatically and test that your link appears in the correct category and that it leads to your User Guide when clicked. Test your User Guide in the browser and contact rehrar if there are any bugs.
### 5.8 Submit Pull Request ### 5.9 Submit Pull Request
You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure to make any changes if requested. You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure to make any changes if requested.
## 6.0 How to make a Moneropedia Entry ## 6.0 How to make a Moneropedia Entry