github.io docs out of date

[millerthegorilla]

Is this a BUG REPORT or FEATURE REQUEST? (leave only one on its own line)

/kind bug

Description

github.io docs for podman image build are out of date/wrong.

Steps to reproduce the issue:

1. navigate to https://containers.github.io/ansible-podman-collections/podman_image_module.html#ansible-collections-containers-podman-podman-image-module

2. note that several options under the build dictionary are not present in the official documentation at https://docs.ansible.com/ansible/latest/collections/containers/podman/podman_image_module.html

Describe the results you received:

I prefer the formatting of the docs on the github.io, it is easier to find all the different ansible podman modules and their descriptions. However, it might be understood that the docs are out of date, I don't know.

Describe the results you expected:

I hoped that they would be up to date.

[sshnaidm]

@millerthegorilla hey, I've updated the docs recently. Can you please point to what exactly missed there? Thanks

[zephyros-dev]

Specifically, the podman_generate_systemd module and podman_unshare plugins on github.io page return 404 Original page (from the README.md file): https://containers.github.io/ansible-podman-collections/index.html https://containers.github.io/ansible-podman-collections/podman_generate_systemd_module.html#ansible-collections-containers-podman-podman-generate-systemd-module https://containers.github.io/ansible-podman-collections/podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become For now, if anyone really need the documentation, the source code DOCSTRING does have them https://github.dev/containers/ansible-podman-collections/blob/865e1cbee9586c4fac6ab216103842c386dfd549/plugins/modules/podman_generate_systemd.py

[millerthegorilla]

if you look at the two urls in my post, you can see that the official docs, and the actual experience, include args for the build keyword that differ from the online docs. Specifically, the file keyword is present on the podman docs but missing from the ansible and actual experience.

[sshnaidm]

if you look at the two urls in my post, you can see that the official docs, and the actual experience, include args for the build keyword that differ from the online docs. Specifically, the file keyword is present on the podman docs but missing from the ansible and actual experience.

The docs in Ansible page are referring to collection version 1.9.4:

This module is part of the containers.podman collection (version 1.9.4).

The docs on this site https://containers.github.io/ansible-podman-collections/ are always referring to the latest code in the repo. Ansible will include version 1.10.0 in its later releases, and then it will update the docs on https://docs.ansible.com accordingly. So everything is correct.

[sshnaidm]

Specifically, the podman_generate_systemd module and podman_unshare plugins on github.io page return 404 Original page (from the README.md file): https://containers.github.io/ansible-podman-collections/index.html https://containers.github.io/ansible-podman-collections/podman_generate_systemd_module.html#ansible-collections-containers-podman-podman-generate-systemd-module https://containers.github.io/ansible-podman-collections/podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become For now, if anyone really need the documentation, the source code DOCSTRING does have them https://github.dev/containers/ansible-podman-collections/blob/865e1cbee9586c4fac6ab216103842c386dfd549/plugins/modules/podman_generate_systemd.py

Thanks, I missed those. Fixing in #520 Now it's there: https://containers.github.io/ansible-podman-collections/podman_generate_systemd_module.html#ansible-collections-containers-podman-podman-generate-systemd-module

[zephyros-dev]

Thanks, I missed those. Fixing in #520 Now it's there: https://containers.github.io/ansible-podman-collections/podman_generate_systemd_module.html#ansible-collections-containers-podman-podman-generate-systemd-module

Thanks for this one. The podman_unshare docs is broken though. I checked out the DOCSTRING here and it does exists, so probably some missing fields during rendering.

[millerthegorilla]

Thanks for your help

[sshnaidm]

@zephyros-dev now should be fine.