pi-hole uses mkdocs, which is a website generator that translates markdown to a nice website solution. it is simple to setup.
pi-hole/docs: The official Pi-hole documentation (github.com) <https://github.com/pi-hole/docs> deployment can be done with github actions where you approve a pull request to main, GitHub can run the builder and send the html to a target directory. now writing the documentation, well that is a different story. DDJ On Fri, Dec 30, 2022 at 9:08 PM Tom Keffer <[email protected]> wrote: > I'm seeing that style of documentation everywhere now. For example, the pip > User Guide <https://pip.pypa.io/en/stable/user_guide/> does something > similar. I wonder what tool produces it? > > I do like using git to distribute and update. More and more tools seem to > be going that direction, too. > > In any case, those are larger projects with staff that are probably > getting paid. I'm just one senior citizen, with a life, plugging away... > > -tk > > On Fri, Dec 30, 2022 at 5:22 PM Vince Skahan <[email protected]> > wrote: > >> Hundreds of newbies seem to be ok with the pihole approach... >> >> - https://docs.pi-hole.net/main/basic-install/ <= one-step automated >> install >> - https://docs.pi-hole.net/main/post-install/ <= what to tweak >> - https://docs.pi-hole.net/main/update/ <= how to update >> - https://docs.pi-hole.net/main/uninstall/ <= how to uninstall >> >> (and their docs are soooooo nice looking now too....) >> >> For weewx a similar bash script approach could handle os detection >> (apt/yum) and installing a webserver (optionally?) and hooking that in. >> Just go with nginx there since it's light+fast and relatively simple. >> >> Personally I love the "pihole -up" to upgrade to current. You can't get >> much simpler than that. Maybe a future "wee_ctl" feature (?) >> >> Folks who want to install the long (ten line) way can of course go >> appropriately wild. Just as pihole does, continue to give'em the >> instructions or they can install the pre-packaged variant for their os. >> >> Re: docs - it would be interesting to see how pihole's are so blasted >> good looking..... >> >> -- >> You received this message because you are subscribed to the Google Groups >> "weewx-development" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to [email protected]. >> To view this discussion on the web visit >> https://groups.google.com/d/msgid/weewx-development/9b6757d9-7baf-429a-ba97-84835066abebn%40googlegroups.com >> <https://groups.google.com/d/msgid/weewx-development/9b6757d9-7baf-429a-ba97-84835066abebn%40googlegroups.com?utm_medium=email&utm_source=footer> >> . >> > -- > You received this message because you are subscribed to the Google Groups > "weewx-development" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/weewx-development/CAPq0zEDpcvx%3D0_yiEcyuW3PRyHF-F%3DqL2ySXfRB%3DyfvZJ-9zBg%40mail.gmail.com > <https://groups.google.com/d/msgid/weewx-development/CAPq0zEDpcvx%3D0_yiEcyuW3PRyHF-F%3DqL2ySXfRB%3DyfvZJ-9zBg%40mail.gmail.com?utm_medium=email&utm_source=footer> > . > -- You received this message because you are subscribed to the Google Groups "weewx-development" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/weewx-development/CACC0i0w242OHAyd9ygOGJfcmg0ahWF-k--iaB2dYfD-LbRoJtg%40mail.gmail.com.
