JohnPreston
commented
1 month ago Hello @AdrKacz Thanks for taking the time to give that feedback! Documentation takes a long time, and I am grateful that some of it can be generated from the docs & code itself :D
With that said, it's quite stuffy to take in and yeah, it can be quite overwhelming. Even myself, I often go back to the docs to figure out how I implemented things :p
I have documented here the link to the labs. The labs is where I had started with concrete life examples of deployments I have made using this project. A lot of Kafka as you can see, not as much in web apps and such. The labs itself has its own repository with the docker compose files. Granted, it probably needs an upgrade and I need to take some time to revisit and update it.
Had you tried out the NGINX example? If not, would you mind having a look and feedback on whether this A/ works B/ explains things well.
Don't be afraid btw, to submit improvements yourself via PRs. OpenSource contributions go well beyond the simple act of writing code.
I will see to addressing with better and probably more gradual examples.
Is your feature request related to a problem? Please describe. The documentation, even though very details and extensive, doesn't include a working example.
Describe the solution you'd like I'd like the documentation to include at least one generic working examples so I can test and use the service quickly without the need to read most of the documentation. Ideally the examples should include minimum infrastructure deployment (no autoscaling, RAM, and vCPU manually set to lower values), and a scale-ready deployment (autoscaling, in-and-out bound, etc.)
Additional context The documentation is very great and complete. However, some working examples at the beginning would make onboarding easier. Indeed, the syntax of the files is peculiar and needs a lot of custom keywords, it is hard to understand how they articulate together without a example that feature them.
Is there is a working example, my apologies, can you please redirect me to it?
Thank you very much for your great work on this tool!