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

Commit

Permalink
Add note to check docsite on FQCNs after moving modules/plugins to co…
Browse files Browse the repository at this point in the history
…llection (#112)

* Add note to check docsite on FQCNs after moving modules/plugins to collection

* Update collection_requirements.rst

Co-authored-by: Felix Fontein <[email protected]>

Co-authored-by: Felix Fontein <[email protected]>
  • Loading branch information
Andersson007 and felixfontein authored Sep 21, 2020
1 parent 6e8234c commit 3f8decb
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion collection_requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Unit Testing
Collections and Working Groups
==============================

* Working group page(s) on a corresponding wiki (if needed. Makes sense if there is a group of modules for working with one common entity, e.g. postgresql, zabbix, grafana, etc.)
* Working group page(s) on a corresponding wiki (if needed. Makes sense if there is a group of modules for working with one common entity, for example postgresql, zabbix, grafana, and so on.)
* Issue for agenda (or pinboard if there aren't regular meetings) as pinned issue in the repository

When moving modules between collections
Expand All @@ -186,6 +186,7 @@ Also:

* change M(), examples, seealso, extended_documentation_fragments to use actual FQCNs (in moved content and in other collections that have references to the content)
* move all related issues / pull requests / wiki pages
* look through ``docs/docsite`` directory of `ansible-base GitHub repository <https://github.com/ansible/ansible>`_ (for example, using the ``grep`` command-line utility) to check if there are examples using the moved modules / plugins to update their FQCNs

See `Migrating content to a different collection <https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#migrating-ansible-content-to-a-different-collection>`_ for complete details.

Expand Down

0 comments on commit 3f8decb

Please sign in to comment.