docs(website): added a tutorial for interacting with a database server by shipsing · Pull Request #9238 · podman-desktop/podman-desktop (original) (raw)

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation17 Commits4 Checks15 Files changed

Conversation

This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

shipsing

@shipsing

Signed-off-by: Shipra Singh shipsing@redhat.com

@shipsing

Signed-off-by: Shipra Singh shipsing@redhat.com

jeffmaury

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering whether MySQL is a good choice when everybody now speak about Postgresql

Also I think there is a missing piece on how to access the database from an application (Java, NodeJS,...)

@shipsing

Thank you, @jeffmaury, for your suggestions. If both community and Red Hat-based users prefer to use PodstgreSQL in place of MySQl, then we can definitely replace the tutorial example.

gastoner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably add the left nav bar, I think the user could make use of this and navigate through the PD using the "images" and "container" icons.

Like so:
image

I think you need to rebase/ download newest version, the cpu/memory usage indicator should now now overlap with the content below (like in picture)

@shipsing

Signed-off-by: Shipra Singh shipsing@redhat.com

@shipsing

Thank you @gastoner for the suggestion. Most of the times, a user automatically navigates to a specific component page as part of the procedural flow. Whenever any manual intervention is required, we can add a step (like click Containers in the left navigation pane) in the procedure to complete the flow. So, no need to capture the entire left nav in the screenshot.
It is a good practice to capture only the relevant part in the screenshot to keep the reader focused on what is happening with each step. Also, the components you see in the left nav might vary based on your Podman Desktop configuration (whether you have set up any extension or a kube cluster). This might confuse readers. We also need to think from maintenance perspective. If any major change happens in the left nav, we might need to update all the screenshots.

@shipsing

@shipsing

@jeffmaury, Could you please verify the PR and confirm? Thanks

jeffmaury

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

I'm missing the integration into external applications (NodeJS, Java, Python) but could be a follow up PR

@shipsing

@jeffmaury, I will create a follow-up PR. Merging that integration piece in this tutorial might make the content a bit complex. I might set up a quick call with you to understand what would be the procedural flow so that i can better plan the content? Thanks a lot.

@shipsing

Signed-off-by: Shipra Singh shipsing@redhat.com

Reviewers

@gastoner gastoner gastoner left review comments

@jeffmaury jeffmaury jeffmaury approved these changes

@slemeur slemeur Awaiting requested review from slemeur slemeur is a code owner

@cdrage cdrage Awaiting requested review from cdrage cdrage is a code owner

@benoitf benoitf Awaiting requested review from benoitf benoitf is a code owner

@Firewall Firewall Awaiting requested review from Firewall Firewall is a code owner