Skip to content
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 and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

import_*/include_* documentation: fix broken docs RST reference #82286

Merged
merged 1 commit into from Nov 27, 2023

Conversation

felixfontein
Copy link
Contributor

SUMMARY

#78262 removed the playbooks_reuse_includes RST label (https://github.com/ansible/ansible/pull/78262/files#diff-730d0c8f8d232df28fdaaa10b95ba8391d053e1911b4fe8e67ca693dd91cb3bc) that various import_*/include_* module documentations reference (the last working link I could find is https://docs.ansible.com/ansible/2.9/user_guide/playbooks_reuse_includes.html, I guess it has been backported to all newer stable branches).

The playbooks_reuse reference points to https://docs.ansible.com/ansible/devel/playbook_guide/playbooks_reuse.html#playbooks-reuse, which I think is an appropriate replacement.

ISSUE TYPE
  • Docs Pull Request

@ansibot ansibot added needs_triage Needs a first human triage before being processed. module This issue/PR relates to a module. labels Nov 26, 2023
@felixfontein
Copy link
Contributor Author

This also fixes several docs build warnings:

/path/to/rst/collections/ansible/builtin/import_playbook_module.rst:763: WARNING: undefined label: 'playbooks_reuse_includes'
/path/to/rst/collections/ansible/builtin/import_role_module.rst:1056: WARNING: undefined label: 'playbooks_reuse_includes'
/path/to/rst/collections/ansible/builtin/import_tasks_module.rst:803: WARNING: undefined label: 'playbooks_reuse_includes'
/path/to/rst/collections/ansible/builtin/include_role_module.rst:1086: WARNING: undefined label: 'playbooks_reuse_includes'
/path/to/rst/collections/ansible/builtin/include_tasks_module.rst:831: WARNING: undefined label: 'playbooks_reuse_includes'

And of course broken links as in https://docs.ansible.com/ansible/latest/collections/ansible/builtin/import_playbook_module.html#see-also.

CC @samccann @oraNod

@bcoca bcoca merged commit 479949a into ansible:devel Nov 27, 2023
62 checks passed
@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label Nov 27, 2023
@felixfontein felixfontein deleted the broken-docs-links branch November 27, 2023 15:36
@felixfontein
Copy link
Contributor Author

@bcoca thanks for reviewing and merging!

felixfontein added a commit to felixfontein/ansible that referenced this pull request Nov 27, 2023
felixfontein added a commit to felixfontein/ansible that referenced this pull request Nov 27, 2023
felixfontein added a commit to felixfontein/ansible that referenced this pull request Nov 27, 2023
@ansible ansible locked and limited conversation to collaborators Dec 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
module This issue/PR relates to a module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants