No description

Find a file

Emmanuel Garette ce617110b9 [tutorial 021] A sub family Inside a family, we can have variables or families. The "type" for family "manual" became unecessary because container an other family, so it's not a variable. In disabled attribute, it's better tu use relative path (we will see the reason in an other slide).		2024-10-23 20:01:18 +02:00
firefox	[tutorial 021] A sub family	2024-10-23 20:01:18 +02:00
firefox.png	[tutorial 020] A family (config and doc)	2024-10-23 20:01:17 +02:00
foxyproxy.png	[init] Discover Rougail	2024-10-23 20:01:08 +02:00
README.md	[tutorial 021] A sub family (config and doc)	2024-10-23 20:01:18 +02:00

README.md

[tutorial 021] A sub family

View the diff

Screenshot

Structure

firefox/00-proxy.yml

---
proxy_mode:
  description: Configure Proxy Access to the Internet
  choices:
    - No proxy
    - Auto-detect proxy settings for this network
    - Use system proxy settings
    - Manual proxy configuration
    - Automatic proxy configuration URL
  default: No proxy

firefox/10-manual.yml

---
manual:
  description: Manual proxy configuration
  type: family

  http_proxy:
    description: HTTP Proxy
    type: family

Generated documentation

foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github

Variables

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

[tutorial 022] A variable inside sub family (diff)