docs(install.adoc) Add podman guide #798
Conversation
Make the language more direct. Use "Kubernetes environment" instead of Kubernetes and OpenShift.
Use the same style for updates as the original material. Introduce both docker and podman in the starting text. Eliminate reader decisions: Move the optional step of installing docker-compose to the docker-compose section.
The docker example exposes port 8080, the docker-compose example 8000. This caused some dissonance the first time I read the docs, as I was expecting both examples to do much the same thing. Noting the different exposed port helps the reader equate one experience to the next.
|
@sturtison It looks great, thanks! |
|
Thanks for the suggestions and your time spent reviewing! Considering them made me look hard at the Kroki install guide once more and think about what it's really trying to do: Get people started by running the Kroki gateway server, then running multiple Kroki containers together (which is what makes Kroki so good). If I'd continued the way I had, whilst correct, it would have confusingly fragmented your original aesthetic of concise minimal documentation. So I've taken your suggestions into account while rewriting the whole top section, integrating docker and podman into the tasks above, while hopefully replicating your aesthetic. Should there be the need for a tutorial, that would be a separate document or exercise. |
Rewrite all sections above the Images section. Integrate podman and new methods of running podman using the docker-compose yaml configuration file. Maintain the focus on the following tasks while showing both Docker and Podman being used: - The Kroki gateway server as a first task - Running multiple Kroki containers together as a second task The additional method in gateway server task is: podman The additional methods in run multiple containers task are: - Podman 3 together with Docker's docker-compose - Podman together with podman-compose Add section About Docker and Podman for Kroki and guidelines for use plus short descriptions.
|
I've made updates based on your suggestions and my reflections and its now suitable for review. Any errors are mine. Hopefully its inline with what you would like to see in the Kroki docs. |
|
Thank you for the consideration in applying your commits. |
In one sentence, the word map was missing. Simplify describing that the one docker-compose file is used for all examples.
|
Thanks for the updates! It's definitely better 👍🏻 I will try to take some time later this week to get it done. |
|
I made a few changes but overall it was really good 🙌🏻 I decided to extract "About Docker and Podman for Kroki" in a dedicated page to keep the "Install" page relatively short. As a follow-up, I think we should extract "Use Kubernetes" in a dedicated page as well. The "Install" menu could look like:
|
ggrossetie
changed the title
|
And it's live! 🎉 |
|
Great! Yes, that change would be good. I could look at that. |
That would be great, thanks again for improving the documentation 👍 |
This PR addresses issue #797
There are multiple commented commits on the same file.