Skip to content

Conversation

@l0rd
Copy link
Member

@l0rd l0rd commented Dec 1, 2025

The windows-tutorial is the first documentation article that we show to a user that has installed podman on Windows. It hasn't been updated since a long time.

The PR includes two distinc commit. One that includes the updates up until v5.7.1 of Podman and a second one with the updates between v5.7.1 and v6.0.0.

Previews of the HTML generated from the md file with pandoc are available on :

Checklist

Ensure you have completed the following checklist for your pull request to be reviewed:

  • Certify you wrote the patch or otherwise have the right to pass it on as an open-source patch by signing all
    commits. (git commit -s). (If needed, use git commit -s --amend). The author email must match
    the sign-off email address. See CONTRIBUTING.md
    for more information.
  • Referenced issues using Fixes: #00000 in commit message (if applicable)
  • Tests have been added/updated (or no tests are needed)
  • Documentation has been updated (or no documentation changes are needed)
  • All commits pass make validatepr (format/lint checks)
  • Release note entered in the section below (or None if no user-facing changes)

Does this PR introduce a user-facing change?

None

@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. release-note-none labels Dec 1, 2025
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Dec 1, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: l0rd

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 1, 2025
@l0rd l0rd marked this pull request as ready for review December 1, 2025 17:54
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 1, 2025
@Luap99
Copy link
Member

Luap99 commented Dec 1, 2025

I did not look at the content and I am unqualified to review windows docs anyway but...

This is a first commit that is supposed to be cherry-picked to branch v5.6.

With the v5.7 release the v5.6 branch is dead and unsupported upstream so we won't do any further changes or releases there.

automatically installs WSL. If the Hyper-V feature is not enabled, you can
enable it by running
`Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All` from
an administrator PowerShell prompt.
Copy link
Member

Choose a reason for hiding this comment

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

iirc, users are directed to reboot with this?

Copy link
Member Author

Choose a reason for hiding this comment

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

After executing the command the user is prompted:
image

@l0rd l0rd force-pushed the win-tutorial-update branch from 0229c3f to 3d1fa3c Compare December 2, 2025 11:05
@l0rd
Copy link
Member Author

l0rd commented Dec 2, 2025

I did not look at the content and I am unqualified to review windows docs anyway but...

This is a first commit that is supposed to be cherry-picked to branch v5.6.

With the v5.7 release the v5.6 branch is dead and unsupported upstream so we won't do any further changes or releases there.

It was my understanding that some v5.6 specific updates to the tutorial would be useful for a podman desktop build. I don't know if that should land in the v5.6 branch on GitHub or somwher else.

Anyway I have added a separate, v6.0 specific, commit so that we can still cherry-pick the v5.6 commit if needed. Or I can squash them too. cc @mheon.

@l0rd
Copy link
Member Author

l0rd commented Dec 2, 2025

I have added the generated HTML versions:

@lstocchi PTAL

@l0rd l0rd changed the title Update the Podman on Windows tutorial for 5.6.x Update the Podman on Windows tutorial Dec 2, 2025
@Luap99
Copy link
Member

Luap99 commented Dec 2, 2025

I did not look at the content and I am unqualified to review windows docs anyway but...

This is a first commit that is supposed to be cherry-picked to branch v5.6.

With the v5.7 release the v5.6 branch is dead and unsupported upstream so we won't do any further changes or releases there.

It was my understanding that some v5.6 specific updates to the tutorial would be useful for a podman desktop build. I don't know if that should land in the v5.6 branch on GitHub or somwher else.

Ack, yeah my point is just we have an established release process and I don't want to make special case for things like this.

Anyway I have added a separate, v6.0 specific, commit so that we can still cherry-pick the v5.6 commit if needed. Or I can squash them too. cc @mheon.

That is totally cool with me, we can also consider backporting this to v5.7 since that branch is active.

@l0rd l0rd force-pushed the win-tutorial-update branch from 1ae1849 to 9876bb0 Compare December 2, 2025 21:29
@lstocchi
Copy link
Contributor

lstocchi commented Dec 3, 2025

@l0rd seems good - do you plan to add more info about hyperv usage (e.g. you must be admin when creating the first hyperv machine ... ) when we're done with the enhancements?

@packit-as-a-service
Copy link

Cockpit tests failed for commit 9876bb0. @martinpitt, @jelly, @mvollmer please check.

@l0rd l0rd force-pushed the win-tutorial-update branch from 9876bb0 to 9285aa0 Compare December 3, 2025 15:30
@l0rd
Copy link
Member Author

l0rd commented Dec 3, 2025

@l0rd seems good - do you plan to add more info about hyperv usage (e.g. you must be admin when creating the first hyperv machine ... ) when we're done with the enhancements?

Yes thank you. I have added a few sentences about it. Both on the 5.7 version (require admins privileges) and the 6.0 (requires admin privileges for first init/rm and beeing a member of the hyper-v admins for the rest of the podman machine subcommands).

@packit-as-a-service
Copy link

Cockpit tests failed for commit 9285aa0. @martinpitt, @jelly, @mvollmer please check.

@Honny1
Copy link
Member

Honny1 commented Dec 4, 2025

LGTM

@l0rd
Copy link
Member Author

l0rd commented Dec 8, 2025

@containers/podman-maintainers PTAL and merge. I would like to cherry-pick the first commit of this PR to branch v5.7 (I have published the resulting article for ease of reading).

@l0rd l0rd added the 5.7 label Dec 10, 2025
`winget install Microsoft.WindowsTerminal`


Installing Podman
Copy link
Member

Choose a reason for hiding this comment

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

I just find it odd that we're documenting a version of Podman that won't be available for several months. I think it will be confusing to anyone trying to figure this out. I think you need at least a note like:

Suggested change
Installing Podman
**NOTE:** The documentation talks about Podman 6.0 in several of the following sections of this document. At the time of this writing, Podman 6.0 is expected to be released in the Spring of 2026. Until that time, this functionality is only available from the [`main`](https:/github.com/containers/podman) release branch in Podman's GitHub Repository.
Installing Podman

Copy link
Member Author

@l0rd l0rd Jan 9, 2026

Choose a reason for hiding this comment

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

For clarification: this PR targets Podman main branch, where the v6.0 source code and documentation live. This particular markdown file is built and included in the v6.0.0 installer (that hasn't been released yet but can already be manually built) and presented to the user after installation of v6.0.0 of Podman. If the user installs Podman a previous version, such as current stable v5.7.1, he will see the version inclued in that installer, not this version.

Copy link
Member Author

@l0rd l0rd Jan 9, 2026

Choose a reason for hiding this comment

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

In the Podman documentation website though, even if a users chose to read v5.7.1 of the doc, they will be redirected to main branch tutorial, which is problematic, but can't be addressed by this PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

@TomSweeneyRedHat I haven't added the note as this PR includes two versions of the same tutorial: one version for Podman v5.7 (in a separate commit, ready to be cherry picked) and another version for Podman v6.0. Hence a Podman v5.7 user should see the right version of the documentation. Are you ok with that?

@TomSweeneyRedHat
Copy link
Member

Other than the 6.0 references and one tiny nit, LGTM.

@TomSweeneyRedHat
Copy link
Member

I'm fine with tending to those post merge.

@baude
Copy link
Member

baude commented Jan 12, 2026

LGTM, one nit

@l0rd l0rd force-pushed the win-tutorial-update branch from 9285aa0 to 0948df1 Compare January 13, 2026 11:48
@l0rd l0rd force-pushed the win-tutorial-update branch from 0948df1 to 6f2df1e Compare January 13, 2026 11:49
@packit-as-a-service
Copy link

[NON-BLOCKING] Packit jobs failed. @containers/packit-build please check. Everyone else, feel free to ignore.

Copy link
Contributor

@mtrmac mtrmac left a comment

Choose a reason for hiding this comment

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

I know ~nothing about the subject; noting this has had 2-3 LGTMs already. I plan to merge after updating the Control Panel reference.

@l0rd l0rd force-pushed the win-tutorial-update branch from 6f2df1e to 87df3e4 Compare January 16, 2026 10:49
@l0rd
Copy link
Member Author

l0rd commented Jan 16, 2026

I know ~nothing about the subject; noting this has had 2-3 LGTMs already. I plan to merge after updating the Control Panel reference.

Thank you for the review @mtrmac.

@mtrmac mtrmac merged commit dc8d2c1 into containers:main Jan 16, 2026
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.7 approved Indicates a PR has been approved by an approver from all required OWNERS files. release-note-none

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants