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

DOCS: M() and seealso links in module docstrings should use FQCN #89

Closed
acozine opened this issue Jul 8, 2020 · 3 comments
Closed

DOCS: M() and seealso links in module docstrings should use FQCN #89

acozine opened this issue Jul 8, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@acozine
Copy link
Contributor

acozine commented Jul 8, 2020

SUMMARY

Update all M() links across the collections included in the ansible PyPI package to use FQCN. See ansible-community/antsibull-build#92 for more detail on how links work.

Related to:
ansible-collections/community.azure#4
ansible-collections/amazon.aws#97
ansible-collections/ansible.netcommon#81
ansible-collections/junipernetworks.junos#79
and many more to come!

If you open an issue or a PR in a collection, please point to it in a comment on this issue.

I'll include a list collections/modules we know have this issue in a comment below.

ISSUE TYPE
  • Bug Report
@acozine
Copy link
Contributor Author

acozine commented Jul 8, 2020 •
edited
Loading

See also #45 (comment) for an overview of changes maintainers should be aware of!

@acozine acozine added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jul 8, 2020
This was referenced Jul 8, 2020
Merged
Merged
Merged
Closed
Merged
@acozine
Copy link
Contributor Author

acozine commented Jul 8, 2020

M() and seealso links that did not have FQCNs (as of July 8) show up as undefined label errors here: https://gist.github.com/abadger/158d752815845cf3e63bbc738ca203f4.

This was referenced Jul 8, 2020
Closed
Merged
Merged
@Andersson007 Andersson007 mentioned this issue Jul 9, 2020
Merged
@Andersson007
Copy link
Contributor

we should also recheck extended_doc_fragments i guess

@samccann samccann mentioned this issue Jul 10, 2020
Closed
This was referenced Jul 12, 2020
Closed
Merged
Closed
Merged
Merged
Merged
This was referenced Jul 29, 2020
Merged
Merged
@acozine acozine mentioned this issue Dec 23, 2020
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
Ansible Community project plan
Archived in project
Community Plan v2
Status: Done
Milestone
No milestone
Development

No branches or pull requests
3 participants
@acozine @samccann @Andersson007