library page creation

+ Revuo Monero published (compressed version with www.ilovepdf.com best quality)
+ Zero to Monero published (all credit to @UkoeHB)
  - version updated on 2018-06-27
+ Mastering Monero (Preview) published (compressed version with www.ilovepdf.com best quality)
+ Readme Update
This commit is contained in:
el00ruobuob 2018-06-21 17:56:08 +02:00 committed by el00ruobuob
parent ff8e76c875
commit 08f9a65900
No known key found for this signature in database
GPG key ID: 8794A50E11FE51A0
23 changed files with 317 additions and 35 deletions

View file

@ -31,11 +31,13 @@ The multilingual update has recently been rolled out. The website now requires m
12.0 How to add a question to the FAQ
13.0 How to translate a page
13.0 How to add a publication to the Library
14.0 How to add a new language
14.0 How to translate a page
15.0 License
15.0 How to add a new language
16.0 License
## 1.0 Introduction
@ -456,37 +458,82 @@ Build your website using `jekyll serve` if it's not rebuilding automatically. If
### 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.
## 13.0 How to translate a page
## 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
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).
### 13.1 Quickstart
### 14.1 Quickstart
* 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
### 13.2 Naviate to correct file
### 14.2 Naviate to correct file
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.
### 13.3 Translate the file
### 14.3 Translate the file
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.
### 13.4 Remove the 'untranslated' snippet
### 14.4 Remove the 'untranslated' snippet
Somewhere on the page (usually the top) should be a snippet that says `{% include untranslated.html %}`. Simply delete this completely from the file. This will remove the orange bar from the bottom saying the page is untranslated.
### 13.5 Build/Test
### 14.5 Build/Test
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.
### 13.6 Submit a Pull Request
### 14.6 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 add a new language
## 15.0 How to add a new language
Whoo boy, this is the big one. Please follow all directions exactly.
### 14.1 _config.yml file
### 15.1 _config.yml file
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.
Example:
@ -495,28 +542,28 @@ languages: ["en", "es", "NEW LANG HERE"]
```
Save and exit the file.
### 14.2 _data folder
### 15.2 _data folder
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.
**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.
### 14.3 _i18n folder
### 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.
**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.**
Enter the .yml file and translate everything there.
### 14.3 Translate
### 15.3 Translate
If you will be translating the content, please refer to section 13.0 in this README for instructions on translating pages.
### 14.4 Build/Test
### 15.4 Build/Test
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.
### 14.5 Submit a Pull Request
### 15.5 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.
## 15.0 Website License
## 16.0 Website License
Copyright (c) 2014-2017, The Monero Project

View file

@ -8,6 +8,8 @@
url: resources/developer-guides/
- name: User Guides
url: resources/user-guides/
- name: Library
url: library
- name: RSS Feed
url: https://getmonero.org/feed.xml
- title: IRC Channels

View file

@ -50,3 +50,5 @@
url: resources/developer-guides
- page: Technical Specs
url: technical-specs
- page: Library
url: library

View file

@ -8,6 +8,8 @@
url: resources/developer-guides/
- name: Guias de Usuario
url: resources/user-guides/
- name: Librería
url: library
- name: RSS Feed
url: https://getmonero.org/feed.xml
- title: Canales IRC

View file

@ -50,3 +50,5 @@
url: resources/developer-guides
- page: Especificaciones técnicas
url: technical-specs
- page: Librería
url: library

View file

@ -8,6 +8,8 @@
url: resources/developer-guides/
- name: Guides Utilisateur
url: resources/user-guides/
- name: Librairie
url: library
- name: Flux RSS
url: https://getmonero.org/feed.xml
- title: Canaux IRC

View file

@ -50,3 +50,5 @@
url: resources/developer-guides
- page: Spécifications Techniques
url: technical-specs
- page: Librairie
url: library

View file

@ -8,6 +8,8 @@
url: resources/developer-guides/
- name: Guide per l'utente
url: resources/user-guides/
- name: Libreria
url: library
- name: RSS Feed
url: https://getmonero.org/feed.xml
- title: IRC Chats

View file

@ -50,3 +50,5 @@
url: resources/developer-guides
- page: Specifiche Tecniche
url: technical-specs
- page: Libreria
url: library

View file

@ -8,6 +8,8 @@
url: resources/developer-guides/
- name: Przewodniki dla użytkowników
url: resources/user-guides/
- name: Księgarnia
url: library
- name: Kanał RSS
url: https://getmonero.org/feed.xml
- title: Kanały IRC

View file

@ -50,3 +50,5 @@
url: resources/developer-guides
- page: Właściwości techniczne
url: technical-specs
- page: Księgarnia
url: library

View file

@ -8,6 +8,8 @@
url: resources/developer-guides/
- name: User Guides
url: resources/user-guides/
- name: Library
url: library
- name: RSS Feed
url: https://getmonero.org/feed.xml
- title: IRC Channels

View file

@ -50,3 +50,5 @@
url: resources/developer-guides
- page: Technical Specs
url: technical-specs
- page: Library
url: library

View file

@ -54,6 +54,7 @@ titles:
ffs-ot: Open Tasks
ffs-wip: Work in Progress
blogbytag: Blog by Tag
library: Library
index:
page_title: "Monero - secure, private, untraceable"
@ -458,6 +459,41 @@ specs:
amount_hidden_title: Amount obfuscation
amount_hidden_mode: Ring confidential transactions
library:
translated: "yes"
description: "Below are some publications, books or magazines available for you to download."
books:
- category: Books
publications:
- name: "Zero to Monero"
file: "Zero-to-Monero-1-0-0.pdf"
abstract: >
A comprehensive conceptual (and technical) explanation of Monero.<br>
We endeavor to teach anyone who knows basic algebra and simple computer science concepts like the bit representation of a number not only how Monero works at a deep and comprehensive level, but also how useful and beautiful cryptography can be.
- name: "Mastering Monero (Preview)"
file: "Mastering-Monero-Preview.pdf"
abstract: >
A guide through the seemingly complex world of Monero.<br>
It includes:
<ul><li>A broad introduction to blockchains and the importance of privacy - ideal for non-technical users.</li>
<li>Discussion of Bitcoins shortcomings and specific solutions provided by Monero.</li>
<li>User stories (illustrating how Monero protects your privacy), analogies, examples, legal/ethical discussions, and code snippets illustrating key technical concepts.</li>
<li>Details of the Monero decentralized network, peer-to-peer architecture, transaction lifecycle, and security principles.</li>
<li>Introductions to technical foundations of Monero, intended for developers, engineers, software architects, and curious users.</li>
<li>New developments such as Kovri, Bulletproofs, Multisignature, Hardware Wallets, etc.</li></ul>
See <a href="https://masteringmonero.com/">Mastering Monero</a> website for info about full version.
- category: Magazines
publications:
- name: "Revuo Monero Q4 2017"
file: "Revuo-2017-Q4.pdf"
abstract: >
Quarterly Monero magazine, Q4 2017 edition.<br>
In this issue, updates about: development, Monero Research Lab, Kovri, and community.
- name: "Revuo Monero Q3 2017"
file: "Monero-Revuo-3Q-2017.pdf"
abstract: >
Quarterly Monero magazine, Q3 2017 edition.<br>
In this issue, updates about: development, Monero Research Lab, Kovri, community, Hardware, and Monerujo.
blog:
title_1: All

View file

@ -54,6 +54,7 @@ titles:
ffs-ot: Open Tasks
ffs-wip: Work in Progress
blogbytag: Blog by Tag
library: Librería
index:
page_title: "Monero - secure, private, untraceable"
@ -457,6 +458,42 @@ specs:
amount_hidden_title: Amount obfuscation
amount_hidden_mode: Ring confidential transactions
library:
translated: "no"
description: "Below are some publications, books or magazines available for you to download."
books:
- category: Books
publications:
- name: "Zero to Monero"
file: "Zero-to-Monero-1-0-0.pdf"
abstract: >
A comprehensive conceptual (and technical) explanation of Monero.<br>
We endeavor to teach anyone who knows basic algebra and simple computer science concepts like the bit representation of a number not only how Monero works at a deep and comprehensive level, but also how useful and beautiful cryptography can be.
- name: "Mastering Monero (Preview)"
file: "Mastering-Monero-Preview.pdf"
abstract: >
A guide through the seemingly complex world of Monero.<br>
It includes:
<ul><li>A broad introduction to blockchains and the importance of privacy - ideal for non-technical users.</li>
<li>Discussion of Bitcoins shortcomings and specific solutions provided by Monero.</li>
<li>User stories (illustrating how Monero protects your privacy), analogies, examples, legal/ethical discussions, and code snippets illustrating key technical concepts.</li>
<li>Details of the Monero decentralized network, peer-to-peer architecture, transaction lifecycle, and security principles.</li>
<li>Introductions to technical foundations of Monero, intended for developers, engineers, software architects, and curious users.</li>
<li>New developments such as Kovri, Bulletproofs, Multisignature, Hardware Wallets, etc.</li></ul>
See <a href="https://masteringmonero.com/">Mastering Monero</a> website for info about full version.
- category: Magazines
publications:
- name: "Revuo Monero Q4 2017"
file: "Revuo-2017-Q4.pdf"
abstract: >
Quarterly Monero magazine, Q4 2017 edition.<br>
In this issue, updates about: development, Monero Research Lab, Kovri, and community.
- name: "Revuo Monero Q3 2017"
file: "Monero-Revuo-3Q-2017.pdf"
abstract: >
Quarterly Monero magazine, Q3 2017 edition.<br>
In this issue, updates about: development, Monero Research Lab, Kovri, community, Hardware, and Monerujo.
blog:
title_1: All
title_2: Blog

View file

@ -55,6 +55,7 @@ titles:
ffs-ot: Taches Ouvertes
ffs-wip: Travail en Cours
blogbytag: Blog par Tag
library: Librairie
index:
page_title: "Monero - sécurisé, confidentiel, intracable"
@ -457,6 +458,42 @@ specs:
amount_hidden_title: Montants masqués
amount_hidden_mode: transactions de cercle confidentielles
library:
translated: "yes"
description: "Vous trouverez ci-dessous des publications, livres ou revues disponibles au téléchargement."
books:
- category: Livres
publications:
- name: "Zero to Monero"
file: "Zero-to-Monero-1-0-0.pdf"
abstract: >
Une explication conceptuelle (et technique) compréhensible de Monero.<br>
Nous nous efforçons d'enseigner à tous ceux qui connaissent les bases de l'algèbre et les concepts des sciences de l'informatique simple, comme la représentation binaire d'un nombre, non seulement comment fonctionne Monero dans le détail et de manière compréhensible, mais également quelle peut être l'utilité et la beauté de la cryptographie.
- name: "Mastering Monero (Preview)"
file: "Mastering-Monero-Preview.pdf"
abstract: |
Un guide à travers le monde apparemment complexe de Monero.<br>
Il contient :
<ul><li>Une vaste introduction aux chaînes de blocs et à l\'importance de la confidentialité, idéale pour les utilisateurs non-techniques.</li>
<li>La discussion des lacunes de Bitcoin et les solutions spécifiques apportées par Monero.</li>
<li>Des scénarios utilisateurs (illustrant de quelle manière Monero protège votre confidentialité), des analogies, des exemples, des discussions juridiques/éthiques et des bribes de code illustrant les concepts techniques clef.</li>
<li>Des détails sur le réseau décentralisé de Monero, l\'architecture pair à pair, le cycle de vie des transactions et les principes de sécurité.</li>
<li>Une introduction aux fondations techniques de Monero, à destination des développeurs, ingénieurs, architectes logiciel et utilisateurs curieux.</li>
<li>Les nouveaux développements, tel que Kovri, les Bulletproofs, les Multisignature, les Portefeuilles Materiel, etc.</li></ul>
Voir le site web de <a href="https://masteringmonero.com/">Mastering Monero</a> pour plus d'informations sur la version complète.
- category: Magazines
publications:
- name: "Revuo Monero Q4 2017"
file: "Revuo-2017-Q4.pdf"
abstract: >
Magazine trimestriel de Monero, édition Q4 2017.<br>
Dans cette parution, des nouvelles concernant : le développement, le laboratoire de Recherche Monero, Kovri et la communauté.
- name: "Revuo Monero Q3 2017"
file: "Monero-Revuo-3Q-2017.pdf"
abstract: >
Magazine trimestriel de Monero, édition Q3 2017.<br>
Dans cette parution, des nouvelles concernant : le développement, le laboratoire de Recherche Monero, Kovri, la communauté, le matériel et Monerujo.
blog:
title_1: Tous les
title_2: Blog

View file

@ -54,6 +54,7 @@ titles:
ffs-ot: Task aperti
ffs-wip: Lavori in Corso
blogbytag: Blog per Tag
library: Libreria
index:
page_title: "Monero - sicuro, privato, non tracciabile"
@ -457,6 +458,42 @@ specs:
amount_hidden_title: Offuscamento ammontare
amount_hidden_mode: Ring confidential transactions (transazioni confidenziali ad anello)
library:
translated: "no"
description: "Below are some publications, books or magazines available for you to download."
books:
- category: Books
publications:
- name: "Zero to Monero"
file: "Zero-to-Monero-1-0-0.pdf"
abstract: >
A comprehensive conceptual (and technical) explanation of Monero.<br>
We endeavor to teach anyone who knows basic algebra and simple computer science concepts like the bit representation of a number not only how Monero works at a deep and comprehensive level, but also how useful and beautiful cryptography can be.
- name: "Mastering Monero (Preview)"
file: "Mastering-Monero-Preview.pdf"
abstract: >
A guide through the seemingly complex world of Monero.<br>
It includes:
<ul><li>A broad introduction to blockchains and the importance of privacy - ideal for non-technical users.</li>
<li>Discussion of Bitcoins shortcomings and specific solutions provided by Monero.</li>
<li>User stories (illustrating how Monero protects your privacy), analogies, examples, legal/ethical discussions, and code snippets illustrating key technical concepts.</li>
<li>Details of the Monero decentralized network, peer-to-peer architecture, transaction lifecycle, and security principles.</li>
<li>Introductions to technical foundations of Monero, intended for developers, engineers, software architects, and curious users.</li>
<li>New developments such as Kovri, Bulletproofs, Multisignature, Hardware Wallets, etc.</li></ul>
See <a href="https://masteringmonero.com/">Mastering Monero</a> website for info about full version.
- category: Magazines
publications:
- name: "Revuo Monero Q4 2017"
file: "Revuo-2017-Q4.pdf"
abstract: >
Quarterly Monero magazine, Q4 2017 edition.<br>
In this issue, updates about: development, Monero Research Lab, Kovri, and community.
- name: "Revuo Monero Q3 2017"
file: "Monero-Revuo-3Q-2017.pdf"
abstract: >
Quarterly Monero magazine, Q3 2017 edition.<br>
In this issue, updates about: development, Monero Research Lab, Kovri, community, Hardware, and Monerujo.
blog:
title_1: Tutti
title_2: Blog

View file

@ -55,6 +55,7 @@ titles:
ffs-ot: Zadania otwarte
ffs-wip: Prace w toku
blogbytag: Blog po tagu
library: Księgarnia
index:
page_title: "Monero - bezpieczne, prywatne, niewykrywalne"
@ -458,6 +459,42 @@ specs:
amount_hidden_title: Ukrycie kwoty
amount_hidden_mode: poufne transakcje pierścieniowe
library:
translated: "no"
description: "Below are some publications, books or magazines available for you to download."
books:
- category: Books
publications:
- name: "Zero to Monero"
file: "Zero-to-Monero-1-0-0.pdf"
abstract: >
A comprehensive conceptual (and technical) explanation of Monero.<br>
We endeavor to teach anyone who knows basic algebra and simple computer science concepts like the bit representation of a number not only how Monero works at a deep and comprehensive level, but also how useful and beautiful cryptography can be.
- name: "Mastering Monero (Preview)"
file: "Mastering-Monero-Preview.pdf"
abstract: >
A guide through the seemingly complex world of Monero.<br>
It includes:
<ul><li>A broad introduction to blockchains and the importance of privacy - ideal for non-technical users.</li>
<li>Discussion of Bitcoins shortcomings and specific solutions provided by Monero.</li>
<li>User stories (illustrating how Monero protects your privacy), analogies, examples, legal/ethical discussions, and code snippets illustrating key technical concepts.</li>
<li>Details of the Monero decentralized network, peer-to-peer architecture, transaction lifecycle, and security principles.</li>
<li>Introductions to technical foundations of Monero, intended for developers, engineers, software architects, and curious users.</li>
<li>New developments such as Kovri, Bulletproofs, Multisignature, Hardware Wallets, etc.</li></ul>
See <a href="https://masteringmonero.com/">Mastering Monero</a> website for info about full version.
- category: Magazines
publications:
- name: "Revuo Monero Q4 2017"
file: "Revuo-2017-Q4.pdf"
abstract: >
Quarterly Monero magazine, Q4 2017 edition.<br>
In this issue, updates about: development, Monero Research Lab, Kovri, and community.
- name: "Revuo Monero Q3 2017"
file: "Monero-Revuo-3Q-2017.pdf"
abstract: >
Quarterly Monero magazine, Q3 2017 edition.<br>
In this issue, updates about: development, Monero Research Lab, Kovri, community, Hardware, and Monerujo.
blog:
title_1: Wszystkie wpisy
title_2: Blog

Binary file not shown.

Binary file not shown.

BIN
library/Revuo-2017-Q4.pdf Normal file

Binary file not shown.

Binary file not shown.

27
library/index.md Normal file
View file

@ -0,0 +1,27 @@
---
layout: custom
title: titles.library
permalink: /library/index.html
---
<div class="about-monero">
<div class="center-xs container description">
<p class="text-center">{% t library.description %}</p>
</div>
{% for book in site.translations[site.lang].library.books %}
<section class="container full">
<div class="info-block">
<h2>{{ book.category }}</h2>
<div>
{% for publication in book.publications %}
<h3><a href="{{ site.baseurl_root }}/library/{{ publication.file }}">{{ publication.name }}</a></h3>
<p>{{ publication.abstract }}</p>
{% endfor %}
</div>
</div>
</section>
{% endfor %}
</div>
<div class="untranslated {% t library.translated %}">
<p>{% t global.untranslated %} <a class="untranslated-link" href="https://github.com/monero-project/monero-site/blob/master/README.md">README</a>.</p>
</div>