stove/rougail-tutorials
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
rougail-tutorials/README.md

12 KiB
Raw Blame History

[tutorial v1.1_031)] A variable with type's parameters

View the diff

Read the documentation

Screenshot

Firefox Proxy setting

Clone and install

To test this tutorial, you need to download this repository and install Rougail:

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

Then switch to the tutorial page:

git switch --detach v1.1_031

Structure

.
└── firefox
    ├── 00-proxy.yml
    └── 10-manual.yml


Contents of the firefox/10-manual.yml file

%YAML 1.2
---
version: 1.1

manual:  # Manual proxy configuration

  http_proxy:  # HTTP Proxy

    address:
      description: HTTP address
      type: domainname
      params:
        allow_ip: true
...

Let's generate the documentation

rougail -m firefox/ -o doc
Variable                                                                                        Description                                                                                    
proxy_mode
choice mandatory		 Configure Proxy Access to the Internet.
Choices:
- No proxy ← (default)
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL

Manual proxy configuration

manual

HTTP Proxy

manual.http_proxy

Variable                                                                                            Description                                                                                        
manual.http_proxy.address
domainname mandatory		 HTTP address.
Validator: the domain name can be an IP

Let's generate the changelog

rougail -m firefox/ -o doc --doc.contents changelog

Modified variable

Variable                                                                                            Description                                                                                        
manual.http_proxy.address
domainname mandatory		 HTTP address.
Validator: the domain name can be an IP