No documentation on how to use this tool

[langfield]

I have what must be the most basic use case imaginable. I want to block all HTTP traffic, on the host machine, a single computer. It took me the better part of a day to just figure out that the Wiki is where you're supposed to look for usage instructions. Note that the words documentation, docs, usage, tutorial, and how to appear nowhere on the website or in the README.

There are no instructions for the simplest possible question a user might have after installation: "How do I turn this thing on?" I understand that it's started by systemctl at the end of installation, but this is by no means clear.

On top of this, in Configuration, which to me seemed like the most natural spot for instructions on how to get this program working, there are explanations of how features work rather than how to do anything, and the links to the existing "good documentation" for DansGuardian are all broken.

In my opinion, the information that you actually need to just block a single site or a single keyword is ludicrously difficult to find for a project this mature.

I think it is especially confusing in the case where you already have e2guardian installed, and are trying to figure out what to do with it. In this case, it would not be unreasonable for a user to skip looking in the Installation section of the Wiki (where IMO the most valuable 'getting-started' instructions are), since they already have it installed. That's assuming they already found the Wiki.

It is possible that I am simply an idiot, and all other new users are quite satisfied with the state of the documentation.

[KDGundermann]

Hi William,
I have tried to rearrange and enhance the documentation on e2guardian.
You may find my draft : here
There is an open pull request but as my documentation is still not complete I am waiting for some feedback / clarification / additions..

[langfield]

@KDGundermann thanks for replying, I looked over your PR and I like the changes you've made a lot. I hope it gets merged sometime soon!

[aupaaus]

There are references/urls to dansguardian in the wiki which fail.

[KDGundermann]

There are references/urls to dansguardian in the wiki which fail.

do you mean in the current wiki or in my new draft ??

[craigbass76]

What wiki? I too am numbing it, and haven't found the wiki yet...

[philipianpearce]

@craigbass76

https://github.com/e2guardian/e2guardian/wiki for published wiki (from top menu in github/e2guardian/e2guardian)
https://github.com/e2guardian/wiki/wiki for w.i.p. Wiki.

I agree that it needs updating - we need more feedback on @KDGundermann draft and volunteers to help with this!