clarify documentation which module should be used for Red Hat Reposit…

…ories Fixes: theforeman#1059
evgeni · Nov 17, 2020 · b3b2372 · b3b2372
1 parent b3058ed
commit b3b2372
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/changelogs/fragments/1059-repository_set-docs.yml b/changelogs/fragments/1059-repository_set-docs.yml
@@ -0,0 +1,2 @@
+bugfixes:
+  - repository_set, repository - clarify documentation which module should be used for Red Hat Repositories (https://github.com/theforeman/foreman-ansible-modules/issues/1059)
diff --git a/plugins/modules/repository.py b/plugins/modules/repository.py
@@ -27,6 +27,10 @@
 description:
   - Crate and manage repositories
 author: "Eric D Helms (@ehelms)"
+notes:
+  - You can configure certain aspects of existing Red Hat Repositories (like I(download_policy)) using this module,
+    but you can't create (enable) or delete (disable) them.
+  - If you want to enable or disable Red Hat Repositories, please use the M(theforeman.foreman.repository_set) module instead.
 options:
   name:
     description:

diff --git a/plugins/modules/repository_set.py b/plugins/modules/repository_set.py
@@ -23,9 +23,9 @@
 ---
 module: repository_set
 version_added: 1.0.0
-short_description: Enable/disable Repositories in Repository Sets
+short_description: Enable/disable Red Hat Repositories
 description:
-  - Enable/disable repositories in repository sets
+  - Enable/disable Red Hat Repositories
 author: "Andrew Kofink (@akofink)"
 options:
   name: