search

ansible / ansible-documentation

Ansible community documentation
https://docs.ansible.com/
GNU General Public License v3.0
84 stars 503 forks source link

update intersphinx links for Ansible 11 #2212

Closed samccann closed 1 day ago

samccann commented 3 days ago

Fixes #2013

samccann commented 3 days ago

This looks to be failing because ansible.builtin.yum module was removed after core 2.15/Ansible 9. Since I'm removing Ansible 9 from intersphinx links because it EOLs soon, the docs build can no longer find it.

@oraNod @felixfontein - I'm at a loss for what to do here. I could add Ansible 9 back to intersphinx, but that's just a bandaid if I'm understanding the problem. I could go into the dnf module docs and remove the link to the yum module. It was added in this PR.

oraNod commented 3 days ago

This looks to be failing because ansible.builtin.yum module was removed after core 2.15/Ansible 9. Since I'm removing Ansible 9 from intersphinx links because it EOLs soon, the docs build can no longer find it.

@oraNod @felixfontein - I'm at a loss for what to do here. I could add Ansible 9 back to intersphinx, but that's just a bandaid if I'm understanding the problem. I could go into the dnf module docs and remove the link to the yum module. It was added in this PR.

@samccann I'm on my mobile but it looks like that's the problem.

docs/docsite/rst/collections/ansible/builtin/dnf_module.rst:1774:0: undefined-label: undefined label: 'ansible_collections.ansible.builtin.yum_module'

maybe just zap that reference?

oraNod commented 2 days ago

@samccann The problem is a reference in the core repo. It's in this line: https://github.com/ansible/ansible/blob/95e3af3e0f6a054988591913a46c95b6aff94cb5/lib/ansible/modules/dnf.py#L298

I'm going to send a PR now to get it fixed but was able to verify it works locally.

oraNod commented 2 days ago

bah. looked back over your comments and you do mention that PR in the core repo (i.e. you were right!). I think we can just update the syntax there so it doesn't try and build a link to an non-existent docs reference.

felixfontein commented 2 days ago

I think this is a bug in antsibull-docs, since there's a redirect (https://github.com/ansible/ansible/blob/95e3af3e0f6a054988591913a46c95b6aff94cb5/lib/ansible/config/ansible_builtin_runtime.yml#L9092) it should still work. I guess the problem is that this is an action plugin redirect and not a module redirect.

felixfontein commented 2 days ago

Just did some testing: an action redirect is preferred over a modules redirect, in case both are there and they disagree.

felixfontein commented 1 day ago

CI will hopefully pass once #2218 and #2217 have been merged.

patchback[bot] commented 1 day ago

Backport to stable-2.18: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.18/da2f83743b56839b76240d8c258931863ea9fb2b/pr-2212

Backported as https://github.com/ansible/ansible-documentation/pull/2221

🤖 @patchback I'm built with octomachinery and my source is open — https://github.com/sanitizers/patchback-github-app.