Verified Commit f833244f authored by Diego Salazar's avatar Diego Salazar
Browse files

Updated User Guides

- Deleted Website section from user guides, will refer to README instead (too much upkeep)
- Put an untranslated snippet on non-English user guides until translated
parent fae1001e
### Make a 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
### Front Matter
```
---
layout: moneropedia
entry: "PUT THE NAME OF THE TERM HERE IN QUOTE, THIS IS HOW IT WILL SHOW UP ON THE LANDING PAGE"
terms: ["PUT", "TERMS", "HERE", "EXPLAINED", "BELOW"]
summary: "PUT SUMMARY OF YOUR ENTRY HERE IN QUOTES"
---
```
There is one thing to highlight. The `terms:` section of the front matter can be filled with as many terms as you would like. This is how other Moneropedia entries will link to this page. You can link to other Moneropedia entries as well in your page by putting an ampersand before the term used, i.e. `@THE-TERM-USED`. This will make an automatic link in the Moneropedia entry to the referred term, replace the @term with the word used in that terms `entry:` area of the front matter, and on hover it will show the summary. How cool is that?
### Write
Write your Moneropedia entry. Remember that you can link to other Moneropedia entries using `@term-used-in-entry` as described above. Just go to the .md file of the Moneropedia entry you want to link to and use any of the terms in the `terms:` field of the front matter. Be sure to write whichever one you choose EXACTLY as shown and preceded by an ampersand.
### Build/Test
Build your website using `jekyll serve` if it's not rebuilding automatically and test check the link to your entry is appearing on the alphabetical list of Moneropedia entries and that it leads to your entry when clicked. Test your Moneropedia entry in the browser and contact rehrar if there are any bugs.
### 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.
\ No newline at end of file
### Edit the .yml file
Navigate to the `/_data/` folder and open `roadmap.yml`. You will notice a list separated by hyphenated `-year` tags.
**DO NOT MESS WITH THE FORMATTING OR INDENTATION OF ANYTHING OR JEKYLL WILL NOT BUILD PROPERLY!**
Find the year that you want to update and copy the code below:
```
- name:
date:
status:
```
and paste it in the correct years `accomplishments:` section IN THE CHRONOLOGICAL ORDER that it will be in. So if there is a accomplishment that happened/is happening before the one you are inputting, make sure it is higher up than yours. If there is an accomplishment that happened/is happening AFTER yours, make sure it is after yours. If you don't have exact dates, just do your best to estimate.
Fill in the data as follows:
* `name:` The name of the accomplishment. Try to keep it short, a sentence or two at most.
* `date:` When the accomplishment happened (past) or when it is expected to happen (future)
* `status:` If the task is done, put `completed`, if the task is currently in the works put `ongoing`, and if work on the task has not yet started to your knowledge, but is expected to, put `upcoming`.
**Make sure the indentation is EXACTLY the same as the other proposals in the area. If it's not the jekyll build WILL fail.**
Save the file.
### Build/Test
Build your website using `jekyll serve` if it's not rebuilding automatically. If the build fails and you receive an error, you may have messed up somewhere in the `roadmap.yml` file back in 10.1. Go back to that section and check the indentation. Yes, it's stupid. Yes, it has to be perfect.
If the build is successful, go to the Events page `/resources/roadmap/` and check to see that the newly added accomplishment is showing up in the correct place in the correct year. Test the page and let rehrar know if there are any bugs.
### Submit a 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.
\ No newline at end of file
If you are acting on behalf of another individual, please make sure you get their permission first before adding them onto the Team page.
### Change the .yml file
Navigate to the `/_data/` folder and open `team.yml`. You will notice a long list separated by main `-area:` tags.
**DO NOT MESS WITH THE FORMATTING OR INDENTATION OF ANYTHING OR JEKYLL WILL NOT BUILD PROPERLY!**
Find the area that you want to update and copy the code below:
```
- name:
url:
```
Put the name or handle of the person in the `name` section and in the `url:` section put the link to their GitHub URL (it must have https:// at the beginning). If they have no GitHub, then you may leave it blank, it won't mess anything up.
**Make sure the indentation is EXACTLY the same as the other proposals in the area. If it's not the jekyll build WILL fail.**
Save the file.
### Build/Test
Build your website using `jekyll serve` if it's not rebuilding automatically. If the build fails and you receive an error, you may have messed up somewhere in the `team.yml` file back in 8.1. Go back to that section and check the indentation. Yes, it's stupid. Yes, it has to be perfect.
If the build is successful, go to the Team page `/community/team/` and check to see that the contributor is showing up in the correct place. Click their GitHub link (if applicable) and make sure it redirects correctly. Test the page and let rehrar know if there are any bugs.
### Submit a 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.
\ No newline at end of file
### Quick Start
* Make file in /resources/user-guides with a .md ending and no spaces in filename.
* Front Matter as in 5.3
* Write User Guide
* Add guide using markdown in the correct category in /resources/user-guides/index.md being careful not to mess with any indentation
* Test/Build
* Submit PR
### 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
### Front Matter
```
---
layout: static_page
title: TITLE OF YOUR USER GUIDE
---
```
### 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.
### Add Guide to the 'User Guide' landing page
In the /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 underneath the others. `[TITLE OF USER GUIDE](LINK-TO-USER-GUIDE.html)`. Please note that the file name in between the paranthases must be EXACTLY the same name as the file name you made in step 5.2, but with a `.html` at the end instead of `.md`.
In the event that you think your User Guide should be in a new Category that doesn't exist yet, contact rehrar to make one for you.
### 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.
### 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.
\ No newline at end of file
---
layout: user-guide
title: How to make a blog post
permalink: /resources/user-guides/website-blog.html
---
{% tf resources/user-guides/website-blog.md %}
\ No newline at end of file
---
layout: user-guide
title: How to add an event
permalink: /resources/user-guides/website-events.html
---
{% tf resources/user-guides/website-events.md %}
\ No newline at end of file
---
layout: user-guide
title: How to add a question to the FAQ
---
{% tf resources/user-guides/website-faq.md %}
\ No newline at end of file
---
layout: user-guide
title: How to make a FFS proposal
permalink: /resources/user-guides/website-ffs.html
---
{% tf resources/user-guides/website-ffs.md %}
\ No newline at end of file
---
layout: user-guide
title: General Website Instructions
permalink: /resources/user-guides/website-general.html
---
{% tf resources/user-guides/website-general.md %}
\ No newline at end of file
---
layout: user-guide
title: How to add a new merchant
permalink: /resources/user-guides/website-merchants.html
---
{% tf resources/user-guides/website-merchants.md %}
\ No newline at end of file
---
layout: user-guide
title: How to add a Moneropedia entry
permalink: /resources/user-guides/website-moneropedia.html
---
{% tf resources/user-guides/website-moneropedia.md %}
\ No newline at end of file
---
layout: user-guide
title: How to update the Roadmap
permalink: /resources/user-guides/website-roadmap.html
---
{% tf resources/user-guides/website-roadmap.md %}
\ No newline at end of file
---
layout: user-guide
title: How to update the Team page
permalink: /resources/user-guides/website-team.html
---
{% tf resources/user-guides/website-team.md %}
\ No newline at end of file
---
layout: user-guide
title: How to make a User Guide
permalink: /resources/user-guides/website-user-guide.html
---
{% tf resources/user-guides/website-user-guide.md %}
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment