monero-project/monero-site
monero-project/monero-site
1
0
Fork 0
mirror of https://github.com/monero-project/monero-site.git synced 2024-09-29 14:01:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

- Updated README with a few more instructions

Browse source 
- Updated events
- Added Mattermost and Taiga to Hangouts page and fixed Reddit icon
- Added icons to Team page to replace links
- Added DragonflyBSD icon to spritesheet and placed on Downloads page
- Added Monero Press Kit page and several PNG and AI files, including a large zip with everything
- Updated Website General User Guide
- Changed Surae's name to Brandon on MRL page
- Several CSS tweaks and fixes
This commit is contained in:
rehrar 2017-09-26 00:20:40 -06:00
parent 7daf9dc6ff
commit f5464b2315
No known key found for this signature in database
GPG key ID: 9B252A4EF355CC8D
34 changed files with 6478 additions and 128 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -32,9 +32,9 @@ Copyright (c) 2014-2017, The Monero Project
## 1.0 Introduction
Greetings everyone, this is rehrar. I'm 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. Please note that translations are not available yet, but when they are added, this document will be updated with instructions on how to translate the content of [getmonero.org](https://getmonero.org/). In the meantime, any help translating this document into another language is greatly appreciated.
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. Please note that translations are not available yet, but when they are added, this document will be updated with instructions on how to translate the content of [getmonero.org website](https://getmonero.org/). In the meantime, any help translating this document into another language is greatly appreciated.
Feel free to skip down to a relevant section if you already know what you need. So to go to the (ADD SECTION HERE) use your find function and type (THING TO TYPE HERE).
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'.
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.
@ -68,11 +68,15 @@ This website is completely open-source however and anything and everything is av
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.
All external links must have http:// or https:// in front of them or they will not redirect properly.
A few random points of note:
- All external links must have http:// or https:// in front of them or they will not redirect properly.
- If you want to add a new page to the navigation, you should note that there are two menus in `header.html`. One for mobile and one for desktop. Your page must be added in the appropriate place in BOTH navigations.
- It is strongly strongly STRONGLY encouraged that you 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.
### 3.1 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 contributer and the issue is not closed we ask that you close it in a timely manner. A contributer (rerhar, 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.
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 contributer and the issue is not closed we ask that you close it in a timely manner. A contributer (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.
#### Pull Requests
Contributers 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.)

2
_data/events.yml
View file

@ -1,3 +1,3 @@
- event: Monero Meetup (Minneapolis, Minnesota) - October 20th, 2017
where: University of Minnesota Campus (Room TBD)
where: University of Minnesota Campus, Bruininks Hall #312
when: 5PM CST, October 20, 2017

2
community/hangouts/index.md
View file

@ -61,7 +61,7 @@ The Monero community is diverse and varied. We come from all over, but we defini
</div>
<div class="row irc">
{% for channel in site.data.irc %}
<div class="col-md-4">
<div class="col-md-4 col-xs-12">
<a href="irc://chat.freenode.net/#{{ channel.channel }}">#{{ channel.channel }}</a>
<p>{{ channel.description }}</p>
</div>

120
community/team/index.md
View file

@ -24,21 +24,17 @@ title: Monero Team
<div class="row center-xs">
<p>{{member.email}}</p>
</div>
{% if member.github %}
<div class="row center-xs">
<a href="{{member.github}}">GitHub</a>
<div class="row center-xs icons">
{% if member.github %}
<a href="{{member.github}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon github"></div></a>
{%endif%}
{% if member.twitter %}
<a href="{{member.twitter}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon twitter"></div></a>
{%endif%}
{% if member.reddit %}
<a href="{{member.reddit}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon reddit"></div></a>
{%endif%}
</div>
{%endif%}
{% if member.twitter %}
<div class="row center-xs">
<a href="{{member.twitter}}">Twitter</a>
</div>
{%endif%}
{% if member.reddit %}
<div class="row center-xs">
<a href="{{member.reddit}}">Reddit</a>
</div>
{%endif%}
</div>
</div>
{%endfor%}
@ -68,21 +64,17 @@ title: Monero Team
<div class="row center-xs">
<h3>{{member.name}}</h3>
</div>
{% if member.github %}
<div class="row center-xs">
<a href="{{member.github}}">GitHub</a>
<div class="row center-xs icons">
{% if member.github %}
<a href="{{member.github}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon github"></div></a>
{%endif%}
{% if member.twitter %}
<a href="{{member.twitter}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon twitter"></div></a>
{%endif%}
{% if member.reddit %}
<a href="{{member.reddit}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon reddit"></div></a>
{%endif%}
</div>
{%endif%}
{% if member.twitter %}
<div class="row center-xs">
<a href="{{member.twitter}}">Twitter</a>
</div>
{%endif%}
{% if member.reddit %}
<div class="row center-xs">
<a href="{{member.reddit}}">Reddit</a>
</div>
{%endif%}
</div>
</div>
{%endfor%}
@ -103,21 +95,17 @@ title: Monero Team
<div class="row center-xs">
<h3>{{member.name}}</h3>
</div>
{% if member.github %}
<div class="row center-xs">
<a href="{{member.github}}">GitHub</a>
<div class="row center-xs icons">
{% if member.github %}
<a href="{{member.github}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon github"></div></a>
{%endif%}
{% if member.twitter %}
<a href="{{member.twitter}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon twitter"></div></a>
{%endif%}
{% if member.reddit %}
<a href="{{member.reddit}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon reddit"></div></a>
{%endif%}
</div>
{%endif%}
{% if member.twitter %}
<div class="row center-xs">
<a href="{{member.twitter}}">Twitter</a>
</div>
{%endif%}
{% if member.reddit %}
<div class="row center-xs">
<a href="{{member.reddit}}">Reddit</a>
</div>
{%endif%}
</div>
</div>
{%endfor%}
@ -138,21 +126,17 @@ title: Monero Team
<div class="row center-xs">
<h3>{{member.name}}</h3>
</div>
{% if member.github %}
<div class="row center-xs">
<a href="{{member.github}}">GitHub</a>
<div class="row center-xs icons">
{% if member.github %}
<a href="{{member.github}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon github"></div></a>
{%endif%}
{% if member.twitter %}
<a href="{{member.twitter}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon twitter"></div></a>
{%endif%}
{% if member.reddit %}
<a href="{{member.reddit}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon reddit"></div></a>
{%endif%}
</div>
{%endif%}
{% if member.twitter %}
<div class="row center-xs">
<a href="{{member.twitter}}">Twitter</a>
</div>
{%endif%}
{% if member.reddit %}
<div class="row center-xs">
<a href="{{member.reddit}}">Reddit</a>
</div>
{%endif%}
</div>
</div>
{%endfor%}
@ -173,21 +157,17 @@ title: Monero Team
<div class="row center-xs">
<h3>{{member.name}}</h3>
</div>
{% if member.github %}
<div class="row center-xs">
<a href="{{member.github}}">GitHub</a>
<div class="row center-xs icons">
{% if member.github %}
<a href="{{member.github}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon github"></div></a>
{%endif%}
{% if member.twitter %}
<a href="{{member.twitter}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon twitter"></div></a>
{%endif%}
{% if member.reddit %}
<a href="{{member.reddit}}" target="_blank" rel="noreferrer, noopener"><div class="col social-icon reddit"></div></a>
{%endif%}
</div>
{%endif%}
{% if member.twitter %}
<div class="row center-xs">
<a href="{{member.twitter}}">Twitter</a>
</div>
{%endif%}
{% if member.reddit %}
<div class="row center-xs">
<a href="{{member.reddit}}">Reddit</a>
</div>
{%endif%}
</div>
</div>
{%endfor%}

60
css/custom.css
View file

@ -989,7 +989,7 @@ h1, h2, h3, h4, h5, h6, p {margin: 0; padding: 0;}
img, video {max-width: 100%;}
video {width: 100%;}
img, video {width: 100%;}
::-webkit-input-placeholder {
color: #AAA;
@ -2598,7 +2598,7 @@ footer {
.download-platforms h2 span.icon-dragonflybsd {
background-image: url(../img/monero-spritesheet.png);
background-position: 0 -13rem;
background-position: 0 -287px;
}
.download-platforms h2 span.icon-github {
@ -2777,7 +2777,7 @@ footer {
/***************************MERCHANTS STYLING***********************************/
.merchants a {
color: #ff7519;
color: #4c4c4c;
margin-top: 0.4rem;
margin-bottom: 0.4rem;
display: inline-block;
@ -3101,6 +3101,10 @@ footer {
padding-left: 0;
}
.team .icons {
margin-top: 1rem;
}
@media only screen and (max-width: 48rem) {
@ -3201,7 +3205,7 @@ footer {
}
.hangouts .social-icon {
.hangouts .social-icon, .team .social-icon {
-moz-box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
-webkit-box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
@ -3211,42 +3215,42 @@ footer {
border-radius: 50%;
}
.hangouts .social-icon.twitter {
.social-icon.twitter {
background-image: url(../img/monero-spritesheet.png);
background-position: -128px -48px;
}
.hangouts .social-icon.twitter:hover {
.social-icon.twitter:hover {
background-image: url(../img/monero-spritesheet.png);
background-position: -176px -48px;
}
.hangouts .social-icon.reddit {
.social-icon.reddit {
background-image: url(../img/monero-spritesheet.png);
background-position: -128px -96px;
}
.hangouts .social-icon.reddit:hover {
.social-icon.reddit:hover {
background-image: url(../img/monero-spritesheet.png);
background-position: -176px -96px;
}
.hangouts .social-icon.facebook {
.social-icon.facebook {
background-image: url(../img/monero-spritesheet.png);
background-position: -128px 0;
}
.hangouts .social-icon.facebook:hover {
.social-icon.facebook:hover {
background-image: url(../img/monero-spritesheet.png);
background-position: -176px 0;
}
.hangouts .social-icon.github {
.social-icon.github {
background-image: url(../img/monero-spritesheet.png);
background-position: -127px -144px;
}
.hangouts .social-icon.github:hover {
.social-icon.github:hover {
background-image: url(../img/monero-spritesheet.png);
background-position: -175px -144px;
}
@ -3278,7 +3282,16 @@ footer {
.hangouts .irc .col-md-4 {
padding: 0;
}
margin-bottom: 1rem;
}
.hangouts .irc .col-md-4:first-child {
margin-top: 1rem;
}
.irc p {
padding-top: 0px;
}
}
@ -3334,6 +3347,27 @@ footer {
}
/**************************PRESS KIT*************************/
.symbol-logo {
height: 159px;
width: 159px;
}
.symbol-logo, .monero-symbol-logo {
margin-top: 0.5rem;
margin-bottom: 0.5rem;
}
.press a {
display: block;
margin-top: 1rem;
}
.press a.adi {
margin-top: 1.5rem;
}
/**************************WHAT IS MONERO*************************/

2
downloads/index.md
View file

@ -78,7 +78,7 @@ If you'd prefer to use a blockchain bootstrap, instead of syncing from scratch,
{% elsif data_downloads.id == "hardware" %}
<div class="row">
<div class="col-md-8 col-md-offset-2 col-sm-12 col-xs-12">
<p>There are currently no hardware wallets available at this time. Please check back for updates.</p>
<p>The Monero community has just funded a <a href="https://forum.getmonero.org/9/work-in-progress/88149/dedicated-monero-hardware-wallet" target="_blank" rel="noreferrer, noopener">Dedicated Hardware Wallet</a> which is now in progress. As well, Ledger is working on <a href="https://github.com/LedgerHQ/blue-app-monero" target="_blank" rel="noreferrer, noopener">integrating Monero into their hardware wallets</a>.</p>
</div></div>
{% elsif data_downloads.id == "mobilelight" %}

2
get-started/contributing/index.md
View file

@ -7,7 +7,6 @@ Monero is an open-source, community-driven project. Described below are several
</div>
<div class="contribute">
<section class="container">
<div class="row">
<!-- full block-->
@ -42,7 +41,6 @@ Mining ensures the Monero network remains decentralized and secure. In the Moner
<div class="row start-xs">
<p>Monero utilizes a <a href="https://forum.getmonero.org">forum funding system</a> whereby projects are proposed for development and community-funded. Funding is held in escrow and remunerated to developers once programming milestones are achieved. Anyone may generate new proposals or fund existing ones.</p>
</div>
</div>
</div>
<!-- full block-->

BIN
img/monero-spritesheet.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 18 KiB

87
press-kit/index.md
View file

@ -1,23 +1,74 @@
---
layout: default
layout: custom
title: "Monero Press Kit"
---
<div class="site-wrap">
<section class="container">
<div class="row">
<section class="container about-monero full col-xs-12">
<div class="info-block">
<div class="row center-xs">
<div class="col"><h2>Monero Press Kit</h2></div>
</div>
<div class="row middle-xs info-block-row">
<div class="col-xs-6">
<img src="" alt="">
</div>
</div>
</div>
</section>
</div>
</section>
<div class="text-center container description">
<p>Here you'll find the Monero symbol and logo below. You can choose any size that you want, or download the .ai file to mess with the logo yourself. <strong>Note that the white background options have a white background under the Monero symbol ONLY, not as a background to the whole image.</strong> Lastly, you can download everything on this page in one zip file by clicking <a href="/press-kit/monero-press-kit.zip">here</a>.</p>
</div>
<section class="container">
<div class="row">
<div class="left half no-pad-sm col-lg-6 col-md-6 col-sm-12 col-xs-12">
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Monero Symbol</h2>
</div>
</div>
<div class="row center-xs">
<img src="/press-kit/symbols/monero-symbol-480.png" alt="Monero Symbol" class="symbol-logo">
</div>
<div class="row center-xs press">
<div class="col-md-6">
<p>No background (PNG)</p>
<a href="/press-kit/symbols/monero-symbol-480.png">Small</a>
<a href="/press-kit/symbols/monero-symbol-800.png">Medium</a>
<a href="/press-kit/symbols/monero-symbol-1280.png">Large</a>
</div>
<div class="col-md-6">
<p>White background (PNG)</p>
<a href="/press-kit/symbols/monero-symbol-on-white-480.png">Small</a>
<a href="/press-kit/symbols/monero-symbol-on-white-800.png">Medium</a>
<a href="/press-kit/symbols/monero-symbol-on-white-1280.png">Large</a>
</div>
</div>
<div class="row center-xs press">
<a href="/press-kit/symbols/monero-symbol.ai" class="adi">Symbol .ai file</a>
</div>
</div>
</div>
<div class="right half col-lg-6 col-md-6 col-sm-12 col-xs-12">
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Monero Logo</h2>
</div>
</div>
<div class="row center-xs">
<div class="col-xs-12">
<img src="/press-kit/logos/monero-logo-480.png" alt="Monero Logo" class="monero-symbol-logo">
</div>
</div>
<div class="row center-xs press">
<div class="col-md-6">
<p>No background (PNG)</p>
<a href="/press-kit/logos/monero-logo-480.png">Small</a>
<a href="/press-kit/logos/monero-logo-800.png">Medium</a>
<a href="/press-kit/logos/monero-logo-1280.png">Large</a>
</div>
<div class="col-md-6">
<p>White background (PNG)</p>
<a href="/press-kit/logos/monero-logo-symbol-on-white-480.png">Small</a>
<a href="/press-kit/logos/monero-logo-symbol-on-white-800.png">Medium</a>
<a href="/press-kit/logos/monero-logo-symbol-on-white-1280.png">Large</a>
</div>
</div>
<div class="row center-xs press">
<div class="col-xs-12">
<a href="/press-kit/logos/monero-logo.ai" class="adi">Logo .ai file</a>
</div>
</div>
</div>
</div>
</div>
</section>

1302
press-kit/logos/Monero Logo.ai Normal file
View file

File diff suppressed because one or more lines are too long

BIN
press-kit/logos/monero-logo-1024.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
press-kit/logos/monero-logo-1280.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
press-kit/logos/monero-logo-480.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 5.3 KiB

BIN
press-kit/logos/monero-logo-560.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 6.2 KiB

BIN
press-kit/logos/monero-logo-800.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 9 KiB

BIN
press-kit/logos/monero-logo-symbol-on-white-1024.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
press-kit/logos/monero-logo-symbol-on-white-1280.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 17 KiB

BIN
press-kit/logos/monero-logo-symbol-on-white-480.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 5.7 KiB

BIN
press-kit/logos/monero-logo-symbol-on-white-560.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 6.7 KiB

BIN
press-kit/logos/monero-logo-symbol-on-white-800.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 9.9 KiB

BIN
press-kit/monero-press-kit.zip Normal file
View file

Binary file not shown.

4970
press-kit/symbols/Monero Symbol.ai Normal file
View file

File diff suppressed because one or more lines are too long

BIN
press-kit/symbols/monero-symbol-1024.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
press-kit/symbols/monero-symbol-1280.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 22 KiB

BIN
press-kit/symbols/monero-symbol-480.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 5.6 KiB

BIN
press-kit/symbols/monero-symbol-560.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 6.8 KiB

BIN
press-kit/symbols/monero-symbol-800.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 10 KiB

BIN
press-kit/symbols/monero-symbol-on-white-1024.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
press-kit/symbols/monero-symbol-on-white-1280.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 27 KiB

BIN
press-kit/symbols/monero-symbol-on-white-480.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 6.6 KiB

BIN
press-kit/symbols/monero-symbol-on-white-560.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 8.1 KiB

BIN
press-kit/symbols/monero-symbol-on-white-800.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 12 KiB

2
resources/research-lab/index.md
View file

@ -155,7 +155,7 @@ This is the original cryptonote paper written by the cryptonote team. Reading it
The Monero Research Lab released an annotated version of the cryptonote whitepaper. This is sort of like an informal review of the claims that are made line-by-line of the whitepaper. It also explains some of the harder concepts in relatively easy to understand terms.
[Surae Noether's Whitepaper Review](https://downloads.getmonero.org/whitepaper_review.pdf)
[Brandon Goodell's Whitepaper Review](https://downloads.getmonero.org/whitepaper_review.pdf)
This paper is a formal review of the original cryptonote paper by MRL researcher Brandon Goodell. He takes an in-depth look at the claims and mathematics presented in the cryptonote paper.

45
resources/user-guides/website-general.md
View file

@ -3,45 +3,56 @@ layout: static_page
title: General Website Instructions
---
### 1.0 Introduction
### Introduction
Greetings everyone, this is rehrar. I'm 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. It'll definitely be a bit of a ride, so strap yourself in. Please note that translations are not available yet, but when they are added, this document will be updated with instructions on how to translate the content of getmonero.org. In the meantime, any help translating this document into another language is greatly appreciated.
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. It'll definitely be a bit of a ride, so strap yourself in. Please note that translations are not available yet, but when they are added, this document will be updated with instructions on how to translate the content of getmonero.org. In the meantime, any help translating this document into another language is greatly appreciated.
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'.
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
### What you'll need
* Jekyll: 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 a Linux-based system you can just follow the instructions on the website to get up and going. 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.
* Jekyll: 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:
* Install Ruby
* Install Bundler: `gem install bundler`
* Install Jekyll with all dependencies (run from the project directory): `bundle`
* 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).
* Markdown experience: To write pages, you're going to need to know how to use Markdown. It's basically a 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.
* 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.
*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.*
* Jekyll Gems: The current iteration of the getmonero.org website uses the following plugins:
* [jekyll-paginate](https://jekyllrb.com/docs/pagination/)
* builder
* rubysl-rexml
* In the event that more gems are added, this documentation will be updated to reflect the changes needed to build the site.
*Note:* To install them all at once, use the command: `gem install builder rubysl-rexml jekyll-paginate`
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:
1. Navigate to the your local `monero-site` repository.
1. Navigate to your local `monero-site` repository.
2. Serve the website: `jekyll serve`
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
### 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.
This website is completely open-source however, and anything and everything is available for changing should the community deem it necessary.
This website is completely open-source however and anything and everything is available for changing should the community deem it necessary.
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.
All external links must have http:// or https:// in front of them or they will not redirect properly.
A few random points of note:
- All external links must have http:// or https:// in front of them or they will not redirect properly.
- If you want to add a new page to the navigation, you should note that there are two menus in `header.html`. One for mobile and one for desktop. Your page must be added in the appropriate place in BOTH navigations.
- It is strongly strongly STRONGLY encouraged that you 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.
### 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 contributer and the issue is not closed we ask that you close it in a timely manner. A contributer (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.
#### Pull Requests
Contributers 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.)
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 contributers on IRC (freenode #monero) and someone should be able to walk you through it.