Clearer documentation for configuration

[Zelaf]

Hello, just spun up this project to use as an alternative to AdGuard since I want to try something different and would like SSO on top!

I did notice however that the configuration for the DNS Zones are manually done and would like some example configs for configuring the zones. For example, with the Matrix Synapse documentation they show the options in a similar manner to what you have but also have a text block with most of the config options and changed the default ones to what they're not usually set to so you can copy paste and edit and understand the formatting of the config files easier.

I'd put in an example like

- cache_ttl: "3600"
  to: 2620:fe::fe;2620:fe::9;
  type: forward_blocky
  blocklists: https://raw.githubusercontent.com/notracking/hosts-blocklists/master/hostnames.txt;https://raw.githubusercontent.com/lassekongo83/Frellwits-filter-lists/master/Frellwits-Swedish-Hosts-File.txt;
- cache_ttl: "3600"
  to: 2620:fe::fe;2620:fe::9;
  type: forward_ip

I did notice that there was a nice config example for the DHCP config but could also be expanded a tad.

[BeryJu]

Thanks for the Issue! I've added a couple more examples to the docs with the commit above, let me know if there's anything else missing (also we now have a search on the docs)

[Zelaf]

Thank you! Just took a look and it's amazingly better for the config! I do wonder if there would be possibility to add an example config for the compose file with environment variables set, for those who are just starting out with Docker. Bound to be someone in the future that has an interest in this project who wants to do that! I would like to make a PR but I'm not sure how the documentation system works, could you link to the docs for it?

Thank you!

[BeryJu]

Add some more examples and update the descriptions with the commit above (with the default compose file you shouldn't actually have to set any environment variables)

The docs are in https://github.com/BeryJu/gravity/tree/main/docs/content/docs (standard markdown, the site is built by a tool called hugo)

[Zelaf]

I was hoping there would be some kind of dropdown available in markdown but apparently not, I'll add a simple hopefully easy to understand explanation then that's able to be copypasted!

[Zelaf]

I've made a PR, hopefully I did as you asked with the commit above, I'm very inexperienced with GitHub and version managers.

PR: #494

[Zelaf]

How would you think about, instead of showing every setting for every server subsystem in Gravity it instead shows the documentation in the same menu flow as the web UI?

With this the option for "Cluster" could be combined, still having the cluster configuration under installation, with a combined page for or subpages for the options for all the modules. Having one page for "Cluster" and a subpage for "Cluster Role configuration" with subpages for the specific roles and their configurations.

Made a shitty preview of how it could look lol. Of course removing the other Role Configuration options, just to streamline where and how to find the things you need to find a bit.

[hassansf]

How is it different than PiHole?