docs: update readme / reorganize #705
Conversation
cdrage
force-pushed
the
update-readme
branch
7 times, most recently
from
5c4134e
to
8155f05
Compare
### What does this PR do? Updates the README with the following: * Removes references to OpenShift * Updates the main screenshot * Reorganizes / rewords some parts of the README * Changes the link to download to the website instead of the GitHub release page ### Screenshot/screencast of this PR <!-- Please include a screenshot or a screencast explaining what is doing this PR --> N/A ### What issues does this PR fix or reference? <!-- Please include any related issue from Podman Desktop repository (or from another issue tracker). --> N/A ### How to test this PR? View it :) <!-- Please explain steps to reproduce --> Signed-off-by: Charlie Drage <charlie@charliedrage.com>
README.md
Outdated
|
|
||
| Install, configure and keep container engine (Podman) up to date. System tray to keep it running and switch Kubernetes contexts. | ||
| Desktop App to interact with containers and pods running in Podman. Connect and deploy Pods to Kubernetes/OpenShift environments. | ||
| Podman Desktop - A graphical tool for developing containers locally and on Kubernetes |
There was a problem hiding this comment.
I don't think the tag line here is right.
We previously define this one: "a GUI for Containers and Kubernetes for application developers". We can surely refine/iterate on it.
Do we need to repeat the name of the tool in the title? Should we go straight into something like "Containers and Kubernetes for application developers"
README.md
Outdated
|
|
||
| Register your interest to join our Early Adopter Program by filling <a href="https://forms.gle/ow73dV7Ce3YLzoXH7" target="_blank">this form</a>. | ||
| Podman Desktop is a graphical interface that enables seamless development with containers and Kubernetes. |
There was a problem hiding this comment.
I think it's not accurate and precise enough.
Giving it a try:
Podman Desktop is a graphical interface that enables application developers to seamlessly work with containers and Kubernetes.
Podman Desktop installs, configures and keeps Podman up to date on your local environment. It provides a system tray, to check status and interact with your container engine without losing focus from other tasks. The desktop application provides a dashboard to interact with containers, images, pods and volumes but also configure your environment with your OCI registries and network settings. Podman Desktop also provides capabilities to connect and deploy pods to Kubernetes environments.
Podman Desktop also support multiple container engines, pick your favourite one and use the tool!
README.md
Outdated
|
|
||
| Find latest binaries for Windows, MacOS and Linux on https://github.com/containers/podman-desktop/releases/ | ||
| ## Download |
There was a problem hiding this comment.
maybe we could include a link to the download page earlier in the readme
Signed-off-by: Charlie Drage <charlie@charliedrage.com>
|
@slemeur PTAL there were some commits after your review |
docs: update readme / reorganize
What does this PR do?
Updates the README with the following:
release page
Screenshot/screencast of this PR
N/A
What issues does this PR fix or reference?
N/A
How to test this PR?
View it :)
Signed-off-by: Charlie Drage charlie@charliedrage.com