Skip to content
This repository has been archived by the owner on Jun 13, 2024. It is now read-only.

Fix module references in documentation to use FQCN #145

Closed
geerlingguy opened this issue Jun 29, 2020 · 0 comments · Fixed by #146
Closed

Fix module references in documentation to use FQCN #145

geerlingguy opened this issue Jun 29, 2020 · 0 comments · Fixed by #146
Labels
type/documentation Improvements or additions to documentation

Comments

@geerlingguy
Copy link
Collaborator

SUMMARY

See: ansible-collections/overview#45 (comment)

the M() and :seealso: sections in each module's DOCUMENTATION block need to use FQCN.

For modules in a collection: M(community.general.apt_rpm)
For modules in ansible-base: M(ansible.builtin.yum)`

More generally, I think I'll also take a pass at making sure all the README and docs refer to the FQCN version of the module to prevent any confusion, while still adding a note that for transitional playbooks you can use the collections keyword, but to prevent potential issues further down the road, it's a good idea to use the FQCN.

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

N/A

ANSIBLE VERSION

N/A

@geerlingguy geerlingguy added the type/documentation Improvements or additions to documentation label Jun 29, 2020
geerlingguy added a commit that referenced this issue Jul 1, 2020
Fixes #145: Use FQCN in module docs and in plugin examples.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant