Documentation issues

[rmoriz]

Hi,

I just wanted to try out firewalld and started to read the documentation website. I've found a couple of issues, of course IMHO

1. General issue: no continuous reading possible, have to go back after each page, checking the next item

2. Concepts https://firewalld.org/documentation/concepts.html

   • no examples of defining zones
   • the headline above the policy part is called "Firewall Rules" IMHO it should be called "Policy Firewall Rules"
   • there is no point at this stage to use "--permanent" in examples, as this topic is addressed later under "Runtime and Permanent Configuration"
   • "Runtime and Permanent Configuration" suggest/uses "--permanent" on each command but doesn't link to https://firewalld.org/documentation/configuration/runtime-versus-permanent.html

3. Directories https://firewalld.org/documentation/configuration/directories.html

   • section "Default and Fallback Configuration"

     • does not mention that the configuration file format is XML
     • does not link to possible types of configuration files (e.g. icmptypes, services and zones.)
     • "Additional icmptypes, services and zones can be provided with packages or by creating files." should specify the proper place to store those files.

   • section "System Specific Configuration"

     • should link to https://firewalld.org/documentation/configuration/firewalld-conf.html

4. Utilities https://firewalld.org/documentation/utilities/

• should describe the tools, right now one has to guess or click and go back, frustrating

4. Zones

• I suggest merging the xml parts of https://firewalld.org/documentation/zone/ with https://firewalld.org/documentation/zone/predefined-zones.html
  and also point to the files on disk (e.g. ) "/usr/lib/firewalld/zones/dmz.xml"

5. Connections, Interfaces and Sources https://firewalld.org/documentation/zone/connections-interfaces-and-sources.html

   • a lot of details missing. How to add set zones for interfaces when both tools are not used?
   • how-to with /etc/network/interfaces, systemd-networkd, netplan, manual etc?

6. Configuration of Zones https://firewalld.org/documentation/zone/configuration-of-zones.html

   • "Or you can create or copy a zone file in one of the configuration directories. /usr/lib/firewalld/zones is used for default"
   • page redundant should be covered by 4.