[Enhancement] Feedback on landing page, documentation and env variables

[dcarrer-git]

Hi,
I'm new to all of this and I'm no developer, so for some stuff I have not the skillset to join and contribute personally.
That being said, if you might be into an "outsider" view:

1. landing page you reach from Google is lackluster, you basically need to enter git page, scroll down then go back to another similar page with documentation
2. documentation itself feels straightforward, and it surely is for people who created the project, but I feel that many other instances of github pages of other projects that can run on docker are way more fool-proof, easy to to go thru and present every step needed without much guess work
3. other Dockerized projects have env variables, but I think there's a degree of higher convenience in those situation where they factored multiple common personalization options inside the docker-compose.override.yml

My take on each point:

1. I would chose either the page you land from google or the git page to use as a documentation platform
2. At least for the first steps and/or super common issue/scenarios I would go with fool proof documentation This would include steps like: git clone, using portainer or a couple of other major variants to get the file and start the container. A step by step copy&paste instruction overview is very practical and convenient. To that I would add examples of a couple of major go to personalizations like for example LDAP/Active Directory, TimeZone and so on
3. I would prepare a commented / guided section on the override docker file for the examples above, which I would probably call override-docker-compose.yml so that's not confusing when tabbing.. this I think would have the effect of avoiding finding env variables nested inside other folders and/or hands-on configuration on python files and other stuff

Centralization and semplification: could also speed up testing and for sure would help if for some reason somebody doesn't handle the software so often and/or comes back when a new release changes some stuff under the hood

Again, not a developer, my 2 cents hoping this could be of help/use :)

Cheers
D.

[Sispheor]

Hello there. Thanks for your feedback and welcome to Github !

1. This is how it works on GitHub. You have a main readme where you can place your documentation. But if you want something a bit fancy you have to provide an URL to something external.
2. Actually for testing we just propose a docker compose up. Not easy enough? What do you propose?
3. I'm not really sure to understand this sentence. But you are not supposed to modify the docker-compose.override.yml. The full configuration is based on env variables.

[dcarrer-git]

For point 2:

As a total newbie what I've experienced was both: have a simple docker file that pulls images from docker hub and you have everything up and running with minimal configuration of said docker compose file. Or I had a couple of files, with a docker override, and an accessible guide on the page that illustrates how you can personalize it. Last case a full blown blown guide with copy paste stuff that gives nothing for granted: clone gitlab repo, the file to use, a centralized point of personalization (most of the cases tend to use a single override compose file).
But again, if this has been created by design with a different approach/scope and it's like only hardcore developer for internal usage I get it, maybe none of this I'm writing makes sense. I'm just comparing to other git projects that offer a docker installations that I've found.

For point 3:
again, maybe I'm too inexperienced, but I'm used to see docker-compose.yml = don't touch this and that are targeted by developers as the file to use to instill personalization.
Inside there I found convenient personalizing everything. I've seen so far for Squest various sparse variables: password, users, ldap/AD, timezone that repeat itself in many files... gives kinda of a "fragmentation" feeling if you get what I mean

Anyway: let me understand if what I say have some relevance to this particular project, I'm maybe out of place here so I accept that I'm not making any valid point and I will no proceed further... no offense taken of course :D and thanks for considering my points and thanks for your time!

Cheers