containers / containers/podman.io_old

podman docs versions out of sync

Open
#485 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
254
Forks
126
PR merge metrics
No merged PRs in 30d

Description

`podman machine init` doesn't support the `--volume` flag anymore, but it's still on the [latest docs](https://docs.podman.io/en/latest/markdown/podman-machine-init.1.html#volume-v-source-target).

![Screenshot 2022-01-10 at 17 02 35](https://user-images.githubusercontent.com/16896053/148807051-e57de926-f386-4b2b-a21c-4e6b0ea81269.png)

Going to the latest version [(3.4.4)](https://docs.podman.io/en/v3.4.4/markdown/podman-machine-init.1.html) explicitly shows the correct docs, without the `--volume` flag.
![Screenshot 2022-01-10 at 17 03 40](https://user-images.githubusercontent.com/16896053/148807214-f6f5d080-5e7c-47a7-ba76-90363689b861.png)

Looks like the docs are here https://github.com/containers/podman/tree/main/docs, but I figured it'd make more sense to post the issue in this repo since it's related to docs and the podman repo only has 2 categories for issues: bug and feature. This is neither a bug with podman nor a feature request.

I'd guess it's is just a readthedocs/sphinx config issue.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by comparing the latest and v3.4.4 pages for podman machine init and then inspect the documentation configuration in the podman.io repository, especially the docs path referenced in the issue. Done means the latest documentation no longer lists the unsupported --volume flag while the versioned documentation remains correct.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.