Summary
This commit is contained in:
parent
4e2ecdf0ae
commit
bf2488afc1
4 changed files with 16 additions and 65 deletions
67
README.md
67
README.md
|
|
@ -1,19 +1,24 @@
|
||||||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
# Description
|
||||||
|
|
||||||
# [tutorial v1.1_000] Creating a structure file
|
This tutorial shows to you an example of Rougail use on how to set a proxy in the Mozilla Firefox browser.
|
||||||
|
|
||||||
[Read the tutorial "Creating a structure file" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file)
|
More precisely, this tutorial aims at reproducing this [Mozilla Firefox](https://www.mozilla.org/firefox/new/) settings page:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Screenshot
|
And the integration of part of the [Firefox FoxyProxy plugin](https://addons.mozilla.org/firefox/addon/foxyproxy-standard/).
|
||||||
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
|
||||||
|
|
||||||
|
The idea is to have a namespace specific to FoxyProxy and to find in it part of the settings that we will have made in the main namespace.
|
||||||
|
|
||||||
## Clone and install
|
This is what the page looks like:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
# Installation
|
||||||
|
|
||||||
To test this tutorial, you need to download this repository and install Rougail:
|
To test this tutorial, you need to download this repository and install Rougail:
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
||||||
cd rougail-tutorials
|
cd rougail-tutorials
|
||||||
python -m venv venv_rougail
|
python -m venv venv_rougail
|
||||||
|
|
@ -21,50 +26,10 @@ python -m venv venv_rougail
|
||||||
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
|
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
Then switch to the tutorial page:
|
# Summary
|
||||||
|
|
||||||
```shell
|
Each step is a separerate commit. You can navigate to history to discover different aspect to the Rougail format.
|
||||||
git switch --detach v1.1_000
|
|
||||||
```
|
|
||||||
|
|
||||||
## Structure
|
- Getting started ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html))
|
||||||
|
- [[tutorial v1.1_000] Creating a structure file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000))
|
||||||
|
|
||||||
<p>
|
|
||||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./">.</a><br/>
|
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/">firefox</a><br/>
|
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
|
||||||
<br/><br/></p>
|
|
||||||
|
|
||||||
Contents of the firefox/00-proxy.yml file
|
|
||||||
|
|
||||||
```yml
|
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
...
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
## User datas
|
|
||||||
|
|
||||||
### Example 1
|
|
||||||
|
|
||||||
#### config/01/config.yml
|
|
||||||
|
|
||||||
|
|
||||||
```yml
|
|
||||||
---
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
#### Output
|
|
||||||
|
|
||||||
```shell
|
|
||||||
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
|
|
||||||
- [[tutorial v1.1_001] Let’s add our first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
...
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
|
||||||
cd rougail-tutorials
|
|
||||||
python -m venv venv_rougail
|
|
||||||
. venv_rougail/bin/activate
|
|
||||||
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
<p>
|
|
||||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./">.</a><br/>
|
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/">firefox</a><br/>
|
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
|
||||||
<br/><br/></p>
|
|
||||||
Loading…
Reference in a new issue