Commit b92767ff authored by D Sal's avatar D Sal

User Guides and FFS Changes

- Changed Milestones to be handled in front matter of each proposal instead of yml
- Updated ReadMe
- Put different ReadMe sections into individual User Guides
parent b07fcb93
......@@ -151,12 +151,10 @@ You're all done. Submit a PR and wait for it to be reviewed and merged. Be sure
## 6.0 How to make a Moneropedia Entry
### 6.1 Quick Start
### 6.2 Make a file
### 6.1 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
### 6.3 Front Matter
### 6.2 Front Matter
```
---
layout: moneropedia
......@@ -168,13 +166,13 @@ 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?
### 6.4 Write
### 6.3 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.
### 6.5 Build/Test
### 6.4 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.
### 6.6 Submit Pull Request
### 6.5 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.
## 7.0 How to make a FFS Proposal
......
......@@ -25,44 +25,10 @@
url: /forum-funding-system/proposals/getmonero-redesign.html
summary: Redesign the official getmonero.org website to make it more accessible and aesthetically pleasing.
author: rehrar
milestones:
- name: Milestone 1 - Front page & restructure
funds: 10% (~XMR 10.70)
done: April 28, 2017
status: completed
- name: Milestone 2 - Design
funds: 40% (~XMR 42.80)
done: July 1, 2017
status: completed
- name: Milestone 3 - Development
funds: 30% (~XMR 32.10)
done: July 1, 2017
status: completed
- name: Milestone 4 - Finishing touches
funds: 20% (~XMR 21.40)
done:
status: upcoming
- stage: Completed Proposals
proposals:
- name: What is Monero? is produced and open-sourced
url: /forum-funding-system/proposals/whatismonero-produced.html
summary: Make an introduction video to Monero.
author: savandra
milestones:
- name: Milestone 1 - Front page & restructure
funds: 10% (~XMR 10.70)
done: April 28, 2017
status: completed
- name: Milestone 2 - Design
funds: 40% (~XMR 42.80)
done: July 1, 2017
status: completed
- name: Milestone 3 - Development
funds: 30% (~XMR 32.10)
done: July 1, 2017
status: completed
- name: Milestone 4 - Finishing touches
funds: 20% (~XMR 21.40)
done:
status: upcoming
\ No newline at end of file
author: savandra
\ No newline at end of file
......@@ -31,6 +31,30 @@ layout: base
<p>This project has been completed. The proposal is kept here both to celebrate the achievements of the Monero community, and for historical accuracy about what was accomplished.</p>
</div>
</div>
{% if page.milestones != nil %}
<div class="row center-xs milestones">
<div class="tab col-xs-12">
<input id="tab-one" type="checkbox" name="tabs" class="accordion">
<label for="tab-one" class="accordion">Milestones</label>
<div class="tab-content">
{% for milestones in page.milestones %}
<div class="row start-xs roadmap">
<div class="col-xs-1">
<span class="{{milestones.status}} ms-{{milestones.status}}"></span>
</div>
<div class="col-xs-11">
<p>{{milestones.name}}</p>
<p><span class="bold">Funds Awarded:</span> {{milestones.funds}}</p>
{% if milestones.done != nil %}
<p><span class="bold">Completion date:</span> {{milestones.done}}</p>
{%endif%}
</div>
</div>
{%endfor%}
</div>
</div>
</div>
{%endif%}
</div>
<div class="info-block text-adapt">
<div class="row center-xs">
......@@ -45,13 +69,16 @@ layout: base
</div>
</section>
<!-- END FULL WIDTH BLOCK -->
<section class="container full">
<section class="container full comments">
<div class="info-block">
<div class="row ">
<div class="row center">
<div class="col-xs-12">
<h2>Comments</h2>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<!-- JAVASCRIPT FOR DISQUS -->
<script data-isso="//xmrket.com/isso" src="//xmrket.com/isso/js/embed.min.js" data-isso-css="false"></script>
<section id="isso-thread"></section>
<!-- SPACE RESERVED FOR COMMENT SYSTEM -->
</div>
</div>
</div>
......
......@@ -81,11 +81,14 @@ layout: base
<!-- END FULL WIDTH BLOCK -->
<section class="container full comments">
<div class="info-block">
<div class="row ">
<div class="row center">
<div class="col-xs-12">
<h2>Comments</h2>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<!-- JAVASCRIPT FOR DISQUS -->
<script data-isso="//xmrket.com/isso" src="//xmrket.com/isso/js/embed.min.js" data-isso-css="false"></script>
<section id="isso-thread"></section>
<!-- SPACE RESERVED FOR COMMENT SYSTEM -->
</div>
</div>
</div>
......
......@@ -22,13 +22,16 @@ layout: base
</div>
</section>
<!-- END FULL WIDTH BLOCK -->
<section class="container full">
<section class="container full comments">
<div class="info-block">
<div class="row ">
<div class="row center">
<div class="col-xs-12">
<h2>Comments</h2>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<!-- JAVASCRIPT FOR DISQUS -->
<script data-isso="//xmrket.com/isso" src="//xmrket.com/isso/js/embed.min.js" data-isso-css="false"></script>
<section id="isso-thread"></section>
<!-- SPACE RESERVED FOR COMMENT SYSTEM -->
</div>
</div>
</div>
......
......@@ -23,13 +23,16 @@ layout: base
</div>
</section>
<!-- END FULL WIDTH BLOCK -->
<section class="container full">
<section class="container full comments">
<div class="info-block">
<div class="row ">
<div class="row center">
<div class="col-xs-12">
<h2>Comments</h2>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<!-- JAVASCRIPT FOR DISQUS -->
<script data-isso="//xmrket.com/isso" src="//xmrket.com/isso/js/embed.min.js" data-isso-css="false"></script>
<section id="isso-thread"></section>
<!-- SPACE RESERVED FOR COMMENT SYSTEM -->
</div>
</div>
</div>
......
......@@ -33,37 +33,30 @@ layout: base
<p>This project has been funded and is being worked on. Keep an eye out here at the bottom of the proposal for updates.</p>
</div>
</div>
{% if page.milestones != nil %}
<div class="row center-xs milestones">
<div class="tab col-xs-12">
<input id="tab-one" type="checkbox" name="tabs" class="accordion">
<label for="tab-one" class="accordion">Milestones</label>
<div class="tab-content">
{% for toplevel in site.data.ffs %}
{% if toplevel.stage == 'Work in Progress' %}
{% for proposals in toplevel.proposals %}
{% if proposals.name == {{page.title}} %}
{% for milestones in proposals.milestones %}
{% for milestones in page.milestones %}
<div class="row start-xs roadmap">
<div class="col-xs-1">
<span class="{{milestones.status}} ms-{{milestones.status}}"></span>
</div>
<div class="col-xs-11">
<p>{{milestones.name}}</p>
<p><span class="bold">Funds Awarded:</span> {{milestones.funds}}</p>
{% if milestones.done != nil %}
<p><span class="bold">Completion date:</span> {{milestones.done}}</p>
{%endif%}
</div>
<div class="col-xs-1">
<span class="{{milestones.status}} ms-{{milestones.status}}"></span>
</div>
<div class="col-xs-11">
<p>{{milestones.name}}</p>
<p><span class="bold">Funds Awarded:</span> {{milestones.funds}}</p>
{% if milestones.done != nil %}
<p><span class="bold">Completion date:</span> {{milestones.done}}</p>
{%endif%}
</div>
</div>
{%endfor%}
{%endif%}
{%endfor%}
{%endif%}
{%endfor%}
{%endfor%}
</div>
</div>
</div>
{%endif%}
</div>
<div class="info-block text-adapt">
<div class="row center-xs">
......@@ -79,13 +72,16 @@ layout: base
</section>
<!-- END FULL WIDTH BLOCK -->
<section class="container full">
<section class="container full comments">
<div class="info-block">
<div class="row ">
<div class="row center">
<div class="col-xs-12">
<h2>Comments</h2>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<!-- JAVASCRIPT FOR DISQUS -->
<script data-isso="//xmrket.com/isso" src="//xmrket.com/isso/js/embed.min.js" data-isso-css="false"></script>
<section id="isso-thread"></section>
<!-- SPACE RESERVED FOR COMMENT SYSTEM -->
</div>
</div>
</div>
......
......@@ -2542,6 +2542,10 @@ footer {
text-decoration: none;
}
.downloads a img {
padding-top: 1rem;
}
.downloads .full>.info-block {
padding: 4rem 5rem;
......@@ -3849,271 +3853,6 @@ footer {
}
}
/*COMMENTS*/
#isso-thread * {
-webkit-box-sizing: border-box;
-moz-box-sizing: border-box;
box-sizing: border-box;
}
#isso-thread a {
text-decoration: none;
}
#isso-thread {
padding: 0;
margin: 0;
}
#isso-thread > h4 {
color: #4c4c4c;
font-weight: bold;
padding-top: 0;
padding-bottom: 1rem;
font-family: 'Open Sans', sans-serif;
}
#isso-thread .textarea {
min-height: 3.625rem;
outline: 0;
}
.isso-comment {
max-width: 68rem;
padding-top: 0.95rem;
margin: 0.95rem auto;
}
.isso-comment:not(:first-of-type),
.isso-follow-up .isso-comment {
border-top: 1px solid rgba(0, 0, 0, 0.1);
}
.isso-comment > div.avatar,
.isso-postbox > .avatar {
display: block;
float: left;
width: 4rem;
margin: 3px 0 0 0;
}
.isso-postbox > .avatar {
float: left;
margin: 0.3125rem 0.625rem 0 0.3125rem;
width: 3rem;
height: 3rem;
overflow: hidden;
}
.isso-comment > div.avatar > svg,
.isso-postbox > .avatar > svg {
max-width: 3rem;
max-height: 3rem;
border: 1px solid rgba(0, 0, 0, 0.2);
border-radius: 3px;
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.1);
}
.isso-comment > div.text-wrapper {
display: block;
}
.isso-comment .isso-follow-up {
padding-left: calc(7% + 20px);
}
.isso-comment > div.text-wrapper > .isso-comment-header, .isso-comment > div.text-wrapper > .isso-comment-footer {
font-size: 0.95rem;
}
.isso-comment > div.text-wrapper > .isso-comment-header {
font-size: 0.85rem;
}
.isso-comment > div.text-wrapper > .isso-comment-header .spacer {
padding: 0 6px;
}
.isso-comment > div.text-wrapper > .isso-comment-header .spacer,
.isso-comment > div.text-wrapper > .isso-comment-header a.permalink,
.isso-comment > div.text-wrapper > .isso-comment-header .note,
.isso-comment > div.text-wrapper > .isso-comment-header a.parent {
color: gray !important;
font-weight: normal;
text-shadow: none !important;
}
.isso-comment > div.text-wrapper > .isso-comment-header .spacer:hover,
.isso-comment > div.text-wrapper > .isso-comment-header a.permalink:hover,
.isso-comment > div.text-wrapper > .isso-comment-header .note:hover,
.isso-comment > div.text-wrapper > .isso-comment-header a.parent:hover {
color: #ff7519 !important;
}
.isso-comment > div.text-wrapper > .isso-comment-header .note {
float: right;
}
.isso-comment > div.text-wrapper > .isso-comment-header .author {
font-weight: bold;
color: #4c4c4c;
}
.isso-comment > div.text-wrapper > .textarea-wrapper .textarea {
margin-top: 0.2rem;
}
.isso-comment > div.text-wrapper > div.text p {
padding-top: 0.5rem;
}
.isso-comment > div.text-wrapper > div.text p:last-child {
margin-bottom: 0.2rem;
}
.isso-comment > div.text-wrapper > div.text h1,
.isso-comment > div.text-wrapper > div.text h2,
.isso-comment > div.text-wrapper > div.text h3,
.isso-comment > div.text-wrapper > div.text h4,
.isso-comment > div.text-wrapper > div.text h5,
.isso-comment > div.text-wrapper > div.text h6 {
font-size: 130%;
font-weight: bold;
}
.isso-comment > div.text-wrapper > div.textarea-wrapper .textarea {
width: 100%;
border: 1px solid #f0f0f0;
box-shadow: 0 0 2px #888;
}
.isso-comment > div.text-wrapper > .isso-comment-footer {
font-size: 0.80em;
color: gray !important;
clear: left;
}
.isso-comment > div.text-wrapper > .isso-comment-footer a {
font-weight: bold;
text-decoration: none;
}
.isso-comment > div.text-wrapper > .isso-comment-footer a:hover {
color: #ff7519 !important;
}
.isso-comment > div.text-wrapper > .isso-comment-footer > a {
position: relative;
top: .2rem;
}
.isso-comment > div.text-wrapper > .isso-comment-footer > a + a {
padding-left: 1.1rem;
}
.isso-comment > div.text-wrapper > .isso-comment-footer .votes {
color: #4c4c4c;
}
.isso-comment > div.text-wrapper > .isso-comment-footer .upvote svg,
.isso-comment > div.text-wrapper > .isso-comment-footer .downvote svg {
position: relative;
top: .2rem;
}
.isso-comment .isso-postbox {
margin-top: 0.8rem;
}
.isso-comment.isso-no-votes span.votes {
display: none;
}
.isso-postbox {
max-width: 68rem;
margin: 0 auto 2rem;
}
.isso-postbox > .form-wrapper {
display: block;
padding: 0;
}
.isso-postbox > .form-wrapper > .auth-section,
.isso-postbox > .form-wrapper > .auth-section .post-action {
display: block;
}
.isso-postbox > .form-wrapper .textarea {
margin: 0;
padding: 0.4rem 0.8rem;
background-color: #fff;
border: 1px solid rgba(0, 0, 0, 0.1);
box-shadow: 0 0 1px rgba(0, 0, 0, 0.1);
}
.isso-postbox > .form-wrapper .textarea.placeholder {
color: #AAA;
font-family: 'Arial', sans-serif;
font-size: 0.83rem;
}
#isso-thread .textarea:focus,
#isso-thread .input-wrapper input:focus {
border-color: rgba(0, 0, 0, 0.5);
color: #4c4c4c;
}
.isso-postbox > .form-wrapper > .auth-section .input-wrapper {
display: inline-block;
position: relative;
max-width: 25%;
margin: 0;
}
.isso-postbox > .form-wrapper > .auth-section .input-wrapper input {
padding: 0.3rem 0.625rem;
max-width: 100%;
background-color: #fff;
line-height: 1.4em;
margin: 0 1rem 0 0;
padding: 0.4rem 0.8rem;
background-color: #fff;
border: 1px solid rgba(0, 0, 0, 0.1);
box-shadow: 0 0 1px rgba(0, 0, 0, 0.1);
}
.isso-postbox > .form-wrapper > .auth-section .post-action {
display: inline-block;
float: right;
margin: 0;
}
.isso-postbox > .form-wrapper > .auth-section .post-action > input {
cursor: pointer;
outline: 0;
background-color: #ff7519;
color: #ffffff;
border: none;
display: inline-block;
font-family: 'Hind', sans-serif;
font-weight: 700;
text-transform: uppercase;
padding: 0 1rem;
white-space: nowrap;
cursor: pointer;
-webkit-transition: background .15s ease, transform .15s ease, box-shadow .15s ease;
-moz-transition: background .15s ease, transform .15s ease, box-shadow .15s ease;
-o-transition: background .15s ease, transform .15s ease, box-shadow .15s ease;
transition: background .15s ease, transform .15s ease, box-shadow .15s ease;
height: 2rem;
line-height: 2rem;
-moz-box-shadow: 0 1px 5px 0 rgba(0,0,0,.07), 0 7px 17px 0 rgba(0,0,0,.1);
-webkit-box-shadow: 0 1px 5px 0 rgba(0,0,0,.07), 0 7px 17px 0 rgba(0,0,0,.1);
box-shadow: 0 1px 5px 0 rgba(0,0,0,.07), 0 7px 17px 0 rgba(0,0,0,.1);
font-size: 0.9rem;
}
.isso-postbox > .form-wrapper > .auth-section .post-action > input:hover {
-webkit-transform: translate(0, -1px);
-moz-transform: translate(0, -1px);
-ms-transform: translate(0, -1px);
-o-transform: translate(0, -1px);
transform: translate(0, -1px);
-moz-box-shadow: 0 7px 14px rgba(50, 50, 93, .1), 0 3px 6px rgba(0, 0, 0, .08);
-webkit-box-shadow: 0 7px 14px rgba(50, 50, 93, .1), 0 3px 6px rgba(0, 0, 0, .08);
box-shadow: 0 7px 14px rgba(50, 50, 93, .1), 0 3px 6px rgba(0, 0, 0, .08);
}
.isso-postbox > .form-wrapper > .auth-section .post-action > input:active {
transform: translate(0, 1px);
-moz-box-shadow: 0 4px 6px rgba(50, 50, 93, .11), 0 1px 3px rgba(0, 0, 0, .08);
-webkit-box-shadow: 0 4px 6px rgba(50, 50, 93, .11), 0 1px 3px rgba(0, 0, 0, .08);
box-shadow: 0 4px 6px rgba(50, 50, 93, .11), 0 1px 3px rgba(0, 0, 0, .08);
border: 1px solid #ff7519;
}
@media screen and (max-width:600px) {
.isso-postbox > .form-wrapper > .auth-section .input-wrapper {
display: block;
max-width: 100%;
margin: 0 0 .3em;
}
.isso-postbox > .form-wrapper > .auth-section .input-wrapper input {
width: 100%;
}
.isso-postbox > .form-wrapper > .auth-section .post-action {
display: block;
float: none;
text-align: right;
}
}
/*************************accordion********************************/
.tab {
......
......@@ -87,6 +87,11 @@ If you'd prefer to use a blockchain bootstrap, instead of syncing from scratch,
<p>The following are mobile or light wallets that are deemed safe by trusted members of the community. If there is a wallet that is not on here, you can request the community check it out. Go to our <a href="/community/hangouts/">Hangouts</a> page to see where we are.</p>
</div>
</div>
<div class="row center-xs">
<div class="col-xs-12">
<a href="https://mymonero.com"><img src="/img/mymonero.png" alt="MyMonero Logo"></a>
</div>
</div>
{% elsif data_downloads.gui_hash == nil and data_downloads.cli_hash != nil %}
......
......@@ -4,6 +4,23 @@ title: Getmonero.org Redesign
address: 4445
paymentid: 3xj3
author: rehrar
milestones:
- name: Milestone 1 - Front page & restructure
funds: 10% (~XMR 10.70)
done: April 28, 2017
status: completed
- name: Milestone 2 - Design
funds: 40% (~XMR 42.80)
done: July 1, 2017
status: completed
- name: Milestone 3 - Development
funds: 30% (~XMR 32.10)
done: July 1, 2017
status: completed
- name: Milestone 4 - Finishing touches
funds: 20% (~XMR 21.40)
done:
status: upcoming
---
At the request of myself , I am editing my proposal that fluffypony recommended I edit that was edited from the initial idea. So, without further ado:
......
......@@ -62,12 +62,21 @@ title: "User Guides"
<div class="info-block">
<div class="row center-xs">
<div class="col">
<h2>Mining</h2>
<h2>Website</h2>
</div>
</div>
<div class="row start-xs text-center" markdown="1">
<div class="row start-xs" markdown="1">
User Guides for Mining coming soon.
[General Web Edit Instructions (READ FIRST!)](website-general.html)
[How to make a blog post](website-blog.html)
[How to make a User Guide](website-user-guide.html)
[How to make a Moneropedia entry](website-moneropedia.html)
[How to make a FFS proposal](website-ffs.html)
[How to update the Team page](website-team.html)
[How to add update Events page](website-events.html)
[How to update the Roadmap](website-roadmap.html)
[How to add a new Merchant](website-merchants.html)
[How to add a new question to the FAQ](website-faq.html)
</div>
</div>
......
---
layout: static_page
title: How to make a blog post
---
### Quick Start
* Make new .md file in _posts (named whatever, no spaces)
* Front Matter (below)
* Write Blog Post
* Test/Build
* Submit PR
### Make a file
Navigate to the _posts folder of the website and make a new file. Be sure the file name has no spaces and the ending is .md
### 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
---
```
### Write
After the front matter is finished you are free to write the remainder of your blog post in markdown.
### 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.
### 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: static_page
title: How to add an event
---
### 9.1 Edit the .yml file
Navigate to the `/_data/` folder and open `events.yml`. You will notice a list separated by hyphenated `-event` 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:
```
- 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`
* `where:` Where the event will take place. Vanue name and address are recommended.
* `when:` Date and time
* `description:` Descriptoin of the happenings of your event
* `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.
\ No newline at end of file
---
layout: static_page
title: How to add a question to the FAQ
---
### Copy/Paste Code
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 repetetive.
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>
<div class="tab-content" markdown="1">
CHANGE ANSWER
</div>
</div>
```
And paste it at the very bottom of the file. Literally underneath everything else.