Clivern / Lynx

🐺 A Fast, Secure and Reliable Terraform Backend, Set up in Minutes.
https://lynx.clivern.com/
MIT License
210 stars 5 forks source link

Improve documentation to be more focused on important stuff #62

Closed uvulpos closed 1 month ago

uvulpos commented 1 month ago

As a potential new user of Lynx, the documentation is confusing to me. In the main readme I expect an overview and not too detailed information about certain things. Thats why I would recommend to create a new docs/how-to folder for certain important documentation. So people can search it up if needed.

Also I would strongly disagree to ship a reverse proxy by default in docker compose, because Port 80 needs higher permissions to use, is sometimes already taken by other applications or the user isn't interested in that stuff. So I would say that's the responsibility of the user to set that up

Recommended Steps:

Clivern commented 1 month ago

@uvulpos thanks for the PR. i have few requests but rest lgtm

Clivern commented 1 month ago

I need to merge the PR to enhance docs and move some things to /docs dir

uvulpos commented 1 month ago

Allright. Would have been back on Saturday l, due to some current other deadlines :)