README.md 41.6 KB
Newer Older
D Sal's avatar
D Sal committed
1
# Monero Website Instructions
D Sal's avatar
D Sal committed
2

xmr-eric's avatar
xmr-eric committed
3
Copyright (c) 2014-2018, The Monero Project
D Sal's avatar
D Sal committed
4

5
## IMPORTANT MULTILANGUAGE UPDATE NOTICE
6
The multilingual update has recently been rolled out. The website now requires more steps to update so everyone can have a smooth experience. Please read all instructions carefully and follow them all! If they are not all followed, this leads to a ton of work for the website maintainers. A warning will be issued to repeat offenders. If you need help/support, you can find it on `#monero-translations` and [Taiga](https://taiga.getmonero.org/project/erciccione-monero-localization/wiki/home)
7

D Sal's avatar
D Sal committed
8
## Table of Contents
D Sal's avatar
D Sal committed
9

D Sal's avatar
D Sal committed
10
1.0 Introduction
D Sal's avatar
D Sal committed
11

D Sal's avatar
D Sal committed
12
2.0 What you'll need
D Sal's avatar
D Sal committed
13

D Sal's avatar
D Sal committed
14
3.0 General change recommendations
D Sal's avatar
D Sal committed
15

D Sal's avatar
D Sal committed
16
4.0 How to make a blog post
D Sal's avatar
D Sal committed
17

D Sal's avatar
D Sal committed
18
5.0 How to make a User Guide
D Sal's avatar
D Sal committed
19

D Sal's avatar
D Sal committed
20
6.0 How to make a Moneropedia entry
D Sal's avatar
D Sal committed
21

D Sal's avatar
D Sal committed
22
7.0 How to make a FFS Proposal
D Sal's avatar
D Sal committed
23

D Sal's avatar
D Sal committed
24
8.0 How to update the Team page
D Sal's avatar
D Sal committed
25

D Sal's avatar
D Sal committed
26
9.0 How to make an Event
D Sal's avatar
D Sal committed
27

D Sal's avatar
D Sal committed
28
10.0 How to update the Roadmap
D Sal's avatar
D Sal committed
29

D Sal's avatar
D Sal committed
30
11.0 How to add a new Merchant
D Sal's avatar
D Sal committed
31

D Sal's avatar
D Sal committed
32
12.0 How to add a question to the FAQ
D Sal's avatar
D Sal committed
33

el00ruobuob's avatar
el00ruobuob committed
34
13.0 How to add a publication to the Library
35

el00ruobuob's avatar
el00ruobuob committed
36
14.0 How to translate a page
37

el00ruobuob's avatar
el00ruobuob committed
38 39 40
15.0 How to add a new language

16.0 License
D Sal's avatar
D Sal committed
41 42 43

## 1.0 Introduction

44
This README here to walk you through everything you need to know to make changes, edits, or even completely new pages for the new [getmonero.org website](https://getmonero.org/). It'll definitely be a bit of a ride, so strap yourself in.
D Sal's avatar
D Sal committed
45

el00ruobuob's avatar
el00ruobuob committed
46
Feel free to skip down to a relevant section if you already know what you need. So to go to the 'How to make a User Guide' section use your find function and type '5.0'.
D Sal's avatar
D Sal committed
47 48 49 50 51

If for any reason you have questions or need to contact us, you can find us on the IRC channel #monero. We'll do whatever we can to help you.

## 2.0 What you'll need

52
* Jekyll: [getmonero.org](https://getmonero.org/) is made using a simple, static website generator called [Jekyll](https://jekyllrb.com/). You will need it installed on your system to test any changes that you made. If you're using Windows, you will want to check out [this site](http://jekyll-windows.juthilo.com/) for instructions on how to get Jekyll working on your system. If you're using a Linux-based system you can just follow the instructions on the website to get up and going:
53 54 55
  * Install Ruby
  * Install Bundler: `gem install bundler`
  * Install Jekyll with all dependencies (run from the project directory): `bundle`
D Sal's avatar
D Sal committed
56 57 58

* GitHub: Pretty much everything in Monero is hosted on [GitHub](https://github.com) and uses Git as the primary version control system. If you're not familiar with how to use Git, you can check out [this tutorial](https://guides.github.com/activities/hello-world/) for a good overview. It will take you through pretty much everything you'll need to know to edit the website. If you haven't already, register for GitHub and fork the [Monero Website repository](https://github.com/monero-project/monero-site).

59
* Markdown experience: To write pages, you're going to need to know how to use Markdown. It's basically an in-between language that enables people who don't know HTML to just write, and it will be compiled into HTML for you. You can find a great Markdown cheat sheet with examples [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). IF you need more help, Google and YouTube are great resources.
D Sal's avatar
D Sal committed
60 61 62 63 64

*Note: If you're confused, feel free to click other files in the same directory (folder) that you are in for the step that you are on to see some working examples. Compare them to the instructions and you should understand better.*

Once you have the above list of things, it's typically a good idea to build the website from your local computer to make sure it works before you make any changes. To do this, complete the following steps:

65
1. Navigate to your local `monero-site` repository.
MaxXor's avatar
MaxXor committed
66
2. Serve the website: `bundle exec jekyll serve`
D Sal's avatar
D Sal committed
67 68 69 70 71 72 73 74 75
3. Open a browser and go to [http://127.0.0.1:4000](http://127.0.0.1:4000).
4. If all went well, you should see the Monero website and you're ready to make changes.

## 3.0 General change recommendations

The average Monero user that will want to contribute to the website should probably stick with making blog posts, user guides, Moneropedia entries, or a Forum Funding System proposal, all of which are covered in this document. If this is all you want to do, don't worry, it's actually not a daunting task at all. If you are not well versed in web development however, it is not recommended you try to do anything beyond that.

If you are a web developer and would like to make large macro-level changes, it would be best to get in contact with rehrar. The HTML/CSS framework is custom, though quite easy to use for a seasoned developer. Still, there are some pages that are more complicated than others and would require fair amounts of styling changes should the structure change significantly.

76
This website is completely open-source however and anything and everything is available for changing should the community deem it necessary.
D Sal's avatar
D Sal committed
77 78 79

Every section from here on out will talk about how to make a specific type of web page. It will start with a bullet point list of what to do for the advanced among you that just want a quick overview. For those who are still learning this list is followed by a detailed explanation, starting with example front matter. Any variable in the front matter written in all caps you are expected to change (make sure your changes are not all caps though). It will then lead you through the rest of the process until it's time to type your content.

80 81 82
A few random points of note:

- All external links must have http:// or https:// in front of them or they will not redirect properly.
83
- If you want to add a new page to the navigation, you should go to ALL LANGUAGES in the `_data/lang` folder including `template` and add the page.
84
- It is strongly strongly STRONGLY encouraged that if you make a change, you - at the minimum - test it on your local machine before submitting a PR. Sometimes unexpected things may happen due to a change. If you change a page, check the whole page on multiple screen sizes and browsers to make sure there wasn't any collateral damage.
D Sal's avatar
D Sal committed
85

86
### 3.1 Housekeeping
87 88 89 90 91 92

#### Editing the Site
When you make an edit to ANY page on the English language of this website, PLEASE copy your changes into the corresponding `/_i18n/template/` file as well.

The Monero Translation workgroup will do their best to keep tabs on all changes of the site, but it'd be nice to notify them that you've changed a page so they can make sure the equivalent pages are changed accordingly in the other languages.

93
#### GitHub Issues
Dimitris Apostolou's avatar
Dimitris Apostolou committed
94
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 (rehrar, SamsungGalaxyPlayer, or other community members, etc) 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.
95 96

#### Pull Requests
Dimitris Apostolou's avatar
Dimitris Apostolou committed
97
Contributors should use [issue keywords](https://help.github.com/articles/closing-issues-using-keywords/) to make it easier for maintainers to close issues when they merge. Include close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved, etc in the commit message or pull request description, so that the correct issue can be closed if your PR is merged. (Example: 'fixes #1234' could close Issue 1234 when merged.)
98

Dimitris Apostolou's avatar
Dimitris Apostolou committed
99
Pull requests allow others to make comments or review your changes to the site. We ask that you remain available to comment or make changes to your PR. Pull requests with pending changes for more than 30 days will be closed and need to be resubmitted in the future. Sometimes someone else's changes might make your changes conflict with the current site. If that happens you may need to rebase your PR. (If you're unsure about how to do so, you can reach out to other contributors on IRC (freenode #monero) and someone should be able to walk you through it.
100

el00ruobuob's avatar
el00ruobuob committed
101 102 103 104
### 3.2 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.
Dimitris Apostolou's avatar
Dimitris Apostolou committed
105
To keep track of those changes, guides are versioned using a snippet at the top of each localized (\_i18n/en/resources/\*-guides) file:
el00ruobuob's avatar
el00ruobuob committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
```
{% assign version = '1.1.0' | split: '.' %}
```
This snippet is responsible for keeping track of the language version.

The based version (English version) is however also tracked in the `Front Matter` from the /resources/user-guides/ or /resources/developer-guides/ directory file:
```
mainVersion:
  - "1"
  - "1"
  - "0"
```

- First number is the Major version number
- Second number is the Minor version number
- Third number is the build number.

When you update a guide, you are responsible for updating this version tracking in every file involved in your update:

Dimitris Apostolou's avatar
Dimitris Apostolou committed
125 126
- For an update on English files, you will update the version tracking number in the `Front Matter` of /resources/\*-guides/ and in \_i18n/en/resources/\*-guides
- For an update on localized files, you will update the version tracking number in the \_i18n/<local>/resources/\*-guides only, and
el00ruobuob's avatar
el00ruobuob committed
127 128 129 130 131 132 133 134 135
  - You will not update to a higher Major or Minor version number than the reference English guide
  - If you want to update to a higher Major or Minor version number, you should update the English version accordingly so that English is always the highest Major.Minor version.

And you will increment the version number in the following way:

- Cosmetic change only (typo, rephrasing, screenshot update with exact same field names and positions): Increment the third number (build number). We do not want to even warn the user about this update in another language.
- Changes that add instructions or explanations (or screenshot updates with different field names and positions), without making the old version misleading for users: Increment the second number (Minor version number) and reset the third to 0. We want to let the user know the English version could be more accurate and helpful to read.
- Changes that makes the old version false, or misleading to users: Increment the first number (Major version number) and reset the second and third to 1.0. We want to discourage users from reading this too outdated version that could lead them to do wrong things (for instance, buy the wrong algo of mining power on nicehash, after a pow change).

D Sal's avatar
D Sal committed
136 137 138
## 4.0 How to make a blog post

### 4.1 Quick Start
el00ruobuob's avatar
el00ruobuob committed
139
* Make new .md file in \_posts (named whatever, no spaces)
D Sal's avatar
D Sal committed
140 141 142 143 144 145
* Front Matter (below)
* Write Blog Post
* Test/Build
* Submit PR

### 4.2 Make a file
el00ruobuob's avatar
el00ruobuob committed
146
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
D Sal's avatar
D Sal committed
147 148 149 150 151 152 153 154 155 156 157 158 159

### 4.3 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
---
```

### 4.4 Write
el00ruobuob's avatar
el00ruobuob committed
160
After the front matter is finished you are free to write the remainder of your blog post in markdown.
D Sal's avatar
D Sal committed
161 162 163 164 165 166 167 168 169 170 171

### 4.5 Build/Test
Build your website using `jekyll serve` if it's not rebuilding automatically and test that your page appears in the 'News' section of the website, as well as the sidebars.

### 4.6 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.

## 5.0 How to make a User Guide

### 5.1 Quick Start

172 173
* Create file in /resources/user-guides with an .md ending and no spaces in filename.
* File content as in 5.3
el00ruobuob's avatar
el00ruobuob committed
174
* Create file in /\_i18n/en/resources/user-guides with the exact same filename as above ending in .md
D Sal's avatar
D Sal committed
175
* Write User Guide
el00ruobuob's avatar
el00ruobuob committed
176
* Add versioning snippet
el00ruobuob's avatar
el00ruobuob committed
177
* Copy User Guide file to ALL LANGUAGES in /\_i18n/[ALL LANGUAGES]/resources/user-guides
el00ruobuob's avatar
el00ruobuob committed
178
* set translation to false in the snippet the top of each language version of your User Guide, except the original language
el00ruobuob's avatar
el00ruobuob committed
179
* 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
D Sal's avatar
D Sal committed
180 181 182 183 184 185
* Test/Build
* Submit PR

### 5.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

186
### 5.3 Content of file
D Sal's avatar
D Sal committed
187 188
```
---
189
layout: user-guide
D Sal's avatar
D Sal committed
190
title: TITLE OF YOUR USER GUIDE
191
permalink: /resources/user-guides/NAME-OF-FILE-GOES-HERE.html
el00ruobuob's avatar
el00ruobuob committed
192 193 194 195
mainVersion:
  - "1"
  - "1"
  - "0"
D Sal's avatar
D Sal committed
196
---
197 198

{% tf resources/user-guides/NAME-OF-FILE-GOES-HERE.md %}
D Sal's avatar
D Sal committed
199 200
```

201 202 203 204 205 206
Copy this exactly and merely change the files names where indicated.

### 5.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.5 Write
D Sal's avatar
D Sal committed
207 208
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.

209 210
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.

el00ruobuob's avatar
el00ruobuob committed
211 212 213 214 215
Add the version snippet at the top of your guide (before your title):
```
{% assign version = '1.1.0' | split: '.' %}
{% include disclaimer.html translated="true" version=page.version %}
```
Dimitris Apostolou's avatar
Dimitris Apostolou committed
216
Your version should start at `1.1.0` as it is the first Major, first Minor, and no cosmetic changes have occurred.
el00ruobuob's avatar
el00ruobuob committed
217

218
### 5.6 Copy User Guide file into all languages
219 220
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.

el00ruobuob's avatar
el00ruobuob committed
221 222
As you paste into each folder, open up the file and edit the snippet at the top of the file (before your title) to mark it untranslated:
`{% include disclaimer.html translated="false" version=page.version %}`. This does not need to be done in the original language that the User Guide was written in.
223

224
### 5.7 Add Guide to the 'User Guide' landing page of EACH LANGUAGE
el00ruobuob's avatar
el00ruobuob committed
225
In the /\_i18n/[ORIGINAL LANGUAGE OF USER GUIDE]/resources/user-guides folder, find the file labeled index.md and open it.
D Sal's avatar
D Sal committed
226 227 228 229 230

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.

qubenix's avatar
qubenix committed
231
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.
D Sal's avatar
D Sal committed
232 233 234

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.

235 236
Repeat the above process for each language version of this index page INCLUDING THE template.

237
### 5.8 Build/Test
D Sal's avatar
D Sal committed
238 239
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.

240
### 5.9 Submit Pull Request
D Sal's avatar
D Sal committed
241 242 243 244
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

el00ruobuob's avatar
el00ruobuob committed
245
### 6.1 Make a Global file
D Sal's avatar
D Sal committed
246
Navigate to the /resources/moneropedia folder and make a new file. Be sure the file name has no spaces and the ending is .md
el00ruobuob's avatar
el00ruobuob committed
247
Fil this file with this exact content:
D Sal's avatar
D Sal committed
248 249 250
```
---
layout: moneropedia
el00ruobuob's avatar
el00ruobuob committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264
---

@moneropedia_article

{% t global.lang_tag %}
{% tf resources/moneropedia/account.md %}

```

### 6.2 Make the localized File
Navigate to the /\_i18n/en/resources/moneropedia folder and make a new file. give it the same <name>.md than in previous step.
Start the file with the front Matter:
```
---
D Sal's avatar
D Sal committed
265 266 267 268 269 270
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"
---
```

Dimitris Apostolou's avatar
Dimitris Apostolou committed
271
There are two things to highlight:  
el00ruobuob's avatar
el00ruobuob committed
272
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?  
Dimitris Apostolou's avatar
Dimitris Apostolou committed
273
The lines must not contain trailing whitespace, and it must be no blank lines added, otherwise the site with not build correctly.
D Sal's avatar
D Sal committed
274

D Sal's avatar
D Sal committed
275
### 6.3 Write
D Sal's avatar
D Sal committed
276 277
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.

el00ruobuob's avatar
el00ruobuob committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
### 6.4 Copy to other languages
Copy the file from the /\_i18n/en/resources/moneropedia folder to the other /\_i18n/<language>/resources/moneropedia folders and add the untranslated snippet at the same time just after the front matter, so it looks like:
```
---
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"
---

{% include untranslated.html %}
```

If you want to translate in your native language, go to the 14.3.2 section below to read about specificities.

### 6.5 Build/Test
D Sal's avatar
D Sal committed
293 294
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.

el00ruobuob's avatar
el00ruobuob committed
295
### 6.6 Submit Pull Request
D Sal's avatar
D Sal committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure to make any changes if requested.

## 7.0 How to make a FFS Proposal

Before starting this section, it is recommended that you read the User Guide for [How the Forum Funding System works](#) as well as the [Forum Funding System Terms and Guidelines](#). If you do not read these expect your FFS proposal to be laughed at, not to mention not funded.

### 7.1 Quick Start

* Read [How the Forum Funding System works](#) and the [Forum Funding System Terms and Guidelines](#).
* Make the .md file in the /forum-funding-system/proposals folder. Remember the name.
* Choose your front matter layout based on whether your proposal is an Idea (`ffs-ideas`) or Open Task (`ffs-ot`) as specified in the above reading
* Fill out the rest of the Front Matter below, leaving the `address` and `paymentid` sections empty
* Edit the ffs.yml file. I strongly recommend you read this section.
* Write the proposal
* Test/Build
* Submit PR

### 7.2 Make the proposal

Navigate to the /forum-funding-system/proposals folder and make a new file. Be sure the file name has no spaces and the ending is .md. It is very important that you remember the EXACT name of this file.

### 7.3 Front Matter

```
---
layout: ffs-ideas OR ffs-ot
title: NAME OF YOUR PROPOSAL
summary: A BRIEF SUMMARY OF YOUR PROPOSAL
author: YOUR NAME OR HANDLE
address:
paymentid:
---
```

The layout will depend on if you are simply presenting an idea that you do not plan to do yourself or if you are presenting an idea that you are capable and willing to do, the chosen layout will be `ffs-ideas` or `ffs-ot` respectively. You can get more information in the [How the Forum Funding System works](#) User Guide. Fill out the next three sections as normal (title, summary, author), but leave the last two (address, paymentid) blank. Again, DO NOT PUT ANYTHING HERE.

### 7.4 Editing the .yml file

el00ruobuob's avatar
el00ruobuob committed
334
Navigate to the /\_data folder and open the file titled `ffs.yml`. In this file you will find a long list of FFS proposals.
D Sal's avatar
D Sal committed
335 336 337 338 339 340 341 342 343 344 345 346

**DO NOT MESS WITH THE FORMATTING OR INDENTATION OF ANYTHING OR JEKYLL WILL NOT BUILD PROPERLY!**

Identify the section you will be placing your proposal in. If you used `ffs-ideas` in the layout variable in the front matter then you will be putting your proposal in `stage: ideas`, and if you used `ffs-ot` in the layout, then you will be putting your proposal in the `stage: Open Tasks`. Copy the following code:

```
- name:
  url: /forum-funding-system/proposals/
  summary:
  author:
```

el00ruobuob's avatar
el00ruobuob committed
347
and paste it as the very top underneath the `proposals:`.
D Sal's avatar
D Sal committed
348 349 350

**Make sure the indentation is EXACTLY the same as the other proposals in the area. If it's not the jekyll build WILL fail. If in doubt, put the line with the hyphen (-name) all the way to the left and press space four time, and then put the remainder of the variables all the way to the left and press space six times.**

el00ruobuob's avatar
el00ruobuob committed
351
Fill in the information.
D Sal's avatar
D Sal committed
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
* `name:` should be the same as the title chosen in 7.3  
* for `url:` you should append the EXACT name of the file as chosen in 7.2 to the current string but with `.html` at the end instead of `.md`. So it should look like `/forum-funding-system/proposals/YOUR-FILE-NAME.html`
* `summary:` should be the same summary copy and pasted from the front matter in 7.3
* `author:` should be your name or handle, again the same as the front matter in 7.3

Sorry for the repetition here, but it's how Jekyll is working to put things correctly.

### 7.5 Write the proposal
Go ahead and write your proposal now. Go back to your .md file in `/forum-funding-system/proposals`. Be sure to follow the [Forum Funding System Terms and Guidelines](#). Let me be the first to thank you for wanting to contribute your time and energy to better Monero.

### 7.6 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 `ffs.yml` file back in 7.4. 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 Forum Funding System section of the website and make sure that your proposal is showing up in the correct areas, and that when the linked is clicked it takes you to the correct page with your proposal. Use this time to read everything for accuracy and make any changes. If not, you will have to do multiple PRs to make edits and updates. It is this way by design so we can keep track of edits made by authors.

### 7.7 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.

## 8.0 How to update the Team page

If you are acting on behalf of another individual, please make sure you get their permission first before adding them onto the Team page.

### 8.1 Change the .yml file
el00ruobuob's avatar
el00ruobuob committed
375
Navigate to the `/_data/` folder and open `team.yml`. You will notice a long list separated by main `-area:` tags.
D Sal's avatar
D Sal committed
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400

**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.

### 8.2 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.

### 8.3 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.

## 9.0 How to make an Event

### 9.1 Edit the .yml file
el00ruobuob's avatar
el00ruobuob committed
401
Navigate to the `/_data/` folder and open `events.yml`. You will notice a  list separated by hyphenated `-event` tags.
D Sal's avatar
D Sal committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416

**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:
```
- event:
  where:
  when:
  description:
  link:
```
and paste it IN THE CHRONOLOGICAL ORDER that it will be in. So if there is an event happening before yours, make sure it is higher up than yours. If there is an event happening AFTER yours, make sure it is after your event.

Fill in the data as follows:
* `event:` The name of the event goes here as well as the date. The recommended format is: `Event Name - January 1st, 2000`
417
* `where:` Where the event will take place. Venue name and address are recommended.
D Sal's avatar
D Sal committed
418
* `when:` Date and time
419
* `description:` Description of the happenings of your event
D Sal's avatar
D Sal committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
* `link:` The website of your event (if applicable, this can be left blank and everything will be ok). This link must have http:// at the beginning if it is an external link.

**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.

### 9.2 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 `events.yml` file back in 9.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 `/community/events/` and check to see that the event is showing up in the correct place. Click their Event url link (if applicable) and make sure it redirects correctly. Test the page and let rehrar know if there are any bugs.

### 9.3 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.

## 10.0 How to update the Roadmap

### 10.1 Edit the .yml file
el00ruobuob's avatar
el00ruobuob committed
437
Navigate to the `/_data/` folder and open `roadmap.yml`. You will notice a list separated by hyphenated `-year` tags.
D Sal's avatar
D Sal committed
438 439 440 441 442 443 444 445 446

**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:
```
447
and paste it in the correct year's `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.
D Sal's avatar
D Sal committed
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468

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.

### 10.2 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.

### 10.3 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.

## 11.0 How to add a new Merchant

### 11.1 Edit the .yml file
el00ruobuob's avatar
el00ruobuob committed
469
Navigate to the `/_data/` folder and open `merchants.yml`. You will notice a list separated by hyphenated `-category` tags.
D Sal's avatar
D Sal committed
470 471 472 473 474 475 476 477 478 479 480

**DO NOT MESS WITH THE FORMATTING OR INDENTATION OF ANYTHING OR JEKYLL WILL NOT BUILD PROPERLY!**

Find the category that best describes your business/service and copy the code below:
```
- name:
  url:
```
and paste it in the correct category under the `merchants:` section.

Fill in the data as follows:
481
* `name:` The name of the business/service.
D Sal's avatar
D Sal committed
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
* `url:` The external url of the business/service. This link must have http:// (or https://) at the beginning if it is an external link.

**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.

### 11.2 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 `merchants.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 Merchants page `/community/merchants/` and check to see that the business is showing up in the correct category and that the link is redirecting correctly. Test the page and let rehrar know if there are any bugs.

### 11.3 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.

## 12.0 How to add a question to the FAQ

### 12.1 Copy/Paste Code
499
Navigate to the `/get-started/faq` folder and open the `index.md` file. Inside you will see HTML code, but you will see it is very repetitive.
D Sal's avatar
D Sal committed
500 501 502 503 504 505

Copy the code below:
```
<div class="tab">
    <input id="tab-CHANGETHIS" type="checkbox" name="tabs" class="accordian">
    <label for="tab-CHANGETHIS" class="accordian">CHANGE QUESTION</label>
el00ruobuob's avatar
el00ruobuob committed
506

D Sal's avatar
D Sal committed
507 508 509 510 511 512 513 514
<div class="tab-content" markdown="1">

CHANGE ANSWER

</div>

</div>
```
515
And paste it at the very bottom of the file (literally underneath everything else).
D Sal's avatar
D Sal committed
516 517 518 519 520 521 522 523 524 525 526

Now we're going to change just a couple of things. Find the section with:
```
<input id="tab-CHANGETHIS" type="checkbox" name="tabs" class="accordian">
<label for="tab-CHANGETHIS" class="accordian">CHANGE QUESTION</label>
```

and change the sections in between the quotes that say 'CHANGETHIS'. Leave the first part `tab-` alone. You can change it to anything really, as long as they are identical in the input and label, but it's good to see what number is on the last FAQ question (i.e. `tab-nine`) and make it the next number.

Now inside the label tag you're going to find where it says 'CHANGE QUESTION' and change it to the Question you want answered.

el00ruobuob's avatar
el00ruobuob committed
527
Lastly, find the words 'CHANGE ANSWER' and change it to the answer of your question.
D Sal's avatar
D Sal committed
528

el00ruobuob's avatar
el00ruobuob committed
529
**DO NOT MESS WITH THE INDENTATION HERE. The div that has `markdown=1` MUST be flush with the left side, the answer to the question must start flush with the left side, and the `</div>` MUST be flush with the left side.**
D Sal's avatar
D Sal committed
530 531 532 533 534 535 536

### 12.2 Build/Test
Build your website using `jekyll serve` if it's not rebuilding automatically. If the build is successful, go to the FAQ page `/get-started/faq/` and check to see that your question is showing up and, when clicked, the answer drops down. If not, check to make sure that the `id="tab-CHANGETHIS"` in the input and the `for="CHANGETHIS"` in the label are identical to each other. Test the page and let rehrar know if there are any bugs.

### 12.3 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.

el00ruobuob's avatar
el00ruobuob committed
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
## 13.0 How to add a publication to the Library

### 13.1 Add your file
Navigate to the `/library/` folder and drop your publication file here.

Please remind to minimize the size of your publication. For PDF, you'll find a large amount of service to compress your file with a minimal loss in quality.

### 13.2 Edit the .yml files
Navigate to the `/_i18n/` folder and open `en.yml`.

Go down until you find the `library` section. You will notice a list separated by hyphenated `-category` tags in a `books:` section.

**DO NOT MESS WITH THE FORMATTING OR INDENTATION OF ANYTHING OR JEKYLL WILL NOT BUILD PROPERLY!**

Find the category that best corresponds your publication and copy the code below:
```
- name: "<name>"
  file: "<filename>"
  abstract: >
    <abstract><br>
    <on multiple lines>
```
and paste it in the correct category under the `publications:` section.

For books, paste it in alphabetical order. For magazines, past it at the top.

Fill in the placeholders as follows:
* `<name>` The name of the publication, as it should be displayed.
* `<file>` The filename you have dropped in `/library/` folder, including extension.
* `<abstract>`,`<on multiple lines>` An abstract for your publication, formatted with html newlines `<br>`

**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.

open other `*.yml` files and copy the same code to it, in the exact same place.

### 13.3 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 a `*.yml` file back in 13.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 Library page `/library/` and check to see that the publication is showing up in the correct category and that the link is downloading correctly. Test the page and let rehrar know if there are any bugs.

### 13.4 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.

## 14.0 How to translate a page
583
In this section you'll find the info you need to translate a page and add a new translation, but keep in mind that Monero has a [Localization Workgroup](https://taiga.getmonero.org/project/erciccione-monero-localization/) who coordinate and give support to translators-volunteers. You can find an updated guide and an example of the workflow we use on our [Guide on Taiga](https://taiga.getmonero.org/project/erciccione-monero-localization/wiki/translating-monero-website) (frequently updated), also, for live support/request of infos, come chat on `#monero-translations` (Freenode/IRC, riot/matrix, MatterMost).
584

el00ruobuob's avatar
el00ruobuob committed
585
### 14.1 Quickstart
586 587 588 589 590 591
* Navigate to the correct language in the /i18n folder and find the page you wish to translate
* Click the file and translate the page, not touching any HTML or markdown.
* Remove `{% include untranslated.html %}` from the page
* Test/Build
* Submit PR

el00ruobuob's avatar
el00ruobuob committed
592
### 14.2 Naviate to correct file
593 594
Go to the /i18n folder and find the two letter code for the language you wish to translate for. Enter that folder and find the file you wish to translate. The filenames are all in English and MUST NOT BE CHANGED.

el00ruobuob's avatar
el00ruobuob committed
595
### 14.3 Translate the file
596 597
Here you can do your translation. Depending on the page, you may have to maneuver around some HTML or markdown. In general, anything between two tags (such as `<p>TRANSLATE THIS</p>`) should be fine. Testing is VERY important, so do NOT skip step 13.4. 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.

el00ruobuob's avatar
el00ruobuob committed
598 599 600 601 602 603 604
#### 14.3.2 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 extanded 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).

Dimitris Apostolou's avatar
Dimitris Apostolou committed
605
* The old *untranslated* snippet must be removed, therefore the next section 14.4 is irrelevant here.
el00ruobuob's avatar
el00ruobuob committed
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625

Finally, your entry should go from:
```
---
entry: "Entry name in English"
terms: ["English", "terms"]
summary: "English summary."
---

{% include untranslated.html %}
```
To:
```
---
entry: "Translated entry name"
terms: ["English", "terms", "translated", "terms"]
summary: "Translated summary."
---
```

el00ruobuob's avatar
el00ruobuob committed
626 627
### 14.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.
628

el00ruobuob's avatar
el00ruobuob committed
629
### 14.5 Build/Test
630 631 632 633
Build your website using `jekyll serve` if it's not rebuilding automatically.

If the build is successful, go to the correct page in the correct language and check to see that everything is translated, and that the page looks identical to the original English page (besides the translated text). Test the page and let rehrar know if there are any bugs.

el00ruobuob's avatar
el00ruobuob committed
634
### 14.6 Submit a Pull Request
635 636
You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure to make any changes if requested.

el00ruobuob's avatar
el00ruobuob committed
637
## 15.0 How to add a new language
638 639
Whoo boy, this is the big one. Please follow all directions exactly.

el00ruobuob's avatar
el00ruobuob committed
640
### 15.1 \_config.yml file
el00ruobuob's avatar
el00ruobuob committed
641
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.
642 643 644 645 646 647 648

Example:
```
languages: ["en", "es", "NEW LANG HERE"]
```
Save and exit the file.

el00ruobuob's avatar
el00ruobuob committed
649
### 15.2 \_data folder
el00ruobuob's avatar
el00ruobuob committed
650
Navigate to the `_data/lang` folder and copy the `template` folder. Paste it into the same folder and the copy renamed to the two letter language code of the language you will be translated to.
651 652 653 654
**The template folder itself should still be there. It should not be renamed. There should be a new folder in addition to the ones that were already there.**

Translate the content of the files. Do not touch anything labeled `url`, and in the roadmap.yml ONLY translate the `name:` content.

el00ruobuob's avatar
el00ruobuob committed
655 656
### 15.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` at the end and change all sections marked 'translated: "yes"' to 'translated: "no"'. Change back to 'yes' once you have translated that section. Now duplicate the `en` folder and rename it with the correct language code.
657
**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.**
658 659 660

Enter the .yml file and translate everything there.

el00ruobuob's avatar
el00ruobuob committed
661
### 15.3 Translate
662 663
If you will be translating the content, please refer to section 13.0 in this README for instructions on translating pages.

el00ruobuob's avatar
el00ruobuob committed
664
### 15.4 Build/Test
665 666
Build your website using `jekyll serve`. If the build is successful, navigate to any page on the site and check to make sure that your language is appearing in the dropdown for languages on both mobile and desktop.

el00ruobuob's avatar
el00ruobuob committed
667
### 15.5 Submit a Pull Request
668 669
You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure to make any changes if requested.

el00ruobuob's avatar
el00ruobuob committed
670
## 16.0 Website License
D Sal's avatar
D Sal committed
671 672 673 674 675 676 677 678 679 680 681 682 683

Copyright (c) 2014-2017, The Monero Project

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

684
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.