Graylog2 / graylog-ansible-role

Ansible role which installs and configures Graylog
Apache License 2.0
212 stars 126 forks source link

Readme Rewrite #180

Closed malcyon closed 3 years ago

malcyon commented 3 years ago

The Readme is a bit confusing to try to navigate quickly. This is a rewrite of the Graylog Ansible Role documentation to bring more clarity and understanding to new users.

Fixes #158

malcyon commented 3 years ago

This is not quite done yet, but I am soliciting feedback on the format and contents. Any input is appreciated.

My priority was to make it easier for people quickly glancing through the page. I think the multiple examples were too confusing. I would like to have a single-instance playbook example and a clustering playbook example. Whether or not I get the second example done is contingent on me setting all that up.

I took the time to explicitely detail all the variables we have available. I would like to add more explanation on that page around what these settings do. The idea is to keep the casual user from having to dig through the code.

malcyon commented 3 years ago

Made some (mostly) minor suggestions, @malcyon. Good stuff.

Thanks! Much appreciated!

malcyon commented 3 years ago

There are a couple open issues around people trying to configure authentication in Elasticsearch and running into errors. It might be a good idea to have an example that sets that up. Or maybe the current example just needs to do that.

malcyon commented 3 years ago

I'm finding all sorts of random stuff, like:

These will have to be separate PRs. Just noting them as things I found while reading over everything.