Skip to content

Commit

Permalink
update docs for develop
Browse files Browse the repository at this point in the history
  • Loading branch information
evgeni committed Jun 26, 2023
1 parent ab3873b commit 39478c4
Show file tree
Hide file tree
Showing 304 changed files with 1,358 additions and 656 deletions.
521 changes: 278 additions & 243 deletions develop/CHANGELOG.html

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions develop/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
Expand Down
20 changes: 20 additions & 0 deletions develop/_sources/CHANGELOG.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@ redhat.satellite Release Notes

This changelog describes changes after version 0.8.1.

v3.11.0
=======

Minor Changes
-------------

- content_view_promote role - also accept all parameters of the `content_view_version` module (https://github.com/theforeman/foreman-ansible-modules/issues/1591)
- content_view_version - include information about the published version in the return value of the module
- job-invocation - add ``recurrence purpose`` and ``description_format`` parameters
- organizations role - accept ``parameters`` and ``ignore_types`` like the module does

Bugfixes
--------

- compute_profile, host - properly support nested VMware clusters (https://bugzilla.redhat.com/show_bug.cgi?id=2211394)
- content_credential - don't require ``content_type`` and ``content`` parameters when removing credentials (https://github.com/theforeman/foreman-ansible-modules/issues/1588)
- content_credentials role - don't require ``content_type`` and ``content`` parameters when removing credentials
- content_view_filter - don't fail when creating a modulemd filter (https://github.com/theforeman/foreman-ansible-modules/issues/1608, https://bugzilla.redhat.com/show_bug.cgi?id=2208557)
- repositories role - don't log repository information when creating products (https://bugzilla.redhat.com/show_bug.cgi?id=2183357)

v3.10.0
=======

Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/activation_key_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.activation_key module -- Manage Activation Keys
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/architecture_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.architecture module -- Manage Architectures
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/auth_source_ldap_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.auth_source_ldap module -- Manage LDAP Authentication Sources
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/bookmark_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.bookmark module -- Manage Bookmarks
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/compute_attribute_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.compute_attribute module -- Manage Compute Attributes
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/compute_profile_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.compute_profile module -- Manage Compute Profiles
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/compute_resource_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.compute_resource module -- Manage Compute Resources
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/config_group_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.config_group module -- Manage (Puppet) Config Groups
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
10 changes: 7 additions & 3 deletions develop/_sources/plugins/content_credential_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_credential module -- Manage Content Credentials
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down Expand Up @@ -121,7 +121,7 @@ Parameters

.. rst-class:: ansible-option-type-line

:ansible-option-type:`string` / :ansible-option-required:`required`
:ansible-option-type:`string`

.. raw:: html

Expand All @@ -133,6 +133,8 @@ Parameters

Content of the content credential

Required when creating a new credential


.. raw:: html

Expand All @@ -155,7 +157,7 @@ Parameters

.. rst-class:: ansible-option-type-line

:ansible-option-type:`string` / :ansible-option-required:`required`
:ansible-option-type:`string`

.. raw:: html

Expand All @@ -167,6 +169,8 @@ Parameters

Type of credential

Required when creating a new credential


.. rst-class:: ansible-option-line

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_export_info module -- List content exports
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_export_library module -- Manage library content exports
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_export_repository module -- Manage repository content e
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_export_version module -- Manage content view version co
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/content_upload_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_upload module -- Upload content to a repository
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_view_filter_info module -- Fetch information about a Co
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_view_filter module -- Manage Content View Filters
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_view_filter_rule_info module -- Fetch information about
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_view_filter_rule module -- Manage content view filter r
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/content_view_info_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_view_info module -- Fetch information about Content Vie
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/content_view_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_view module -- Manage Content Views
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_view_version_info module -- Fetch information about Con
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.content_view_version module -- Manage Content View Versions
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/cp_label_filter.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.cp_label filter -- Convert strings to Candlepin labels
.. Collection note
.. note::
This filter plugin is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This filter plugin is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.

Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/discovery_rule_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.discovery_rule module -- Manage Host Discovery Rules
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/domain_info_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.domain_info module -- Fetch information about Domains
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/domain_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.domain module -- Manage Domains
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/external_usergroup_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.external_usergroup module -- Manage External User Groups
.. Collection note
.. note::
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this module,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ redhat.satellite.foreman_architecture module
.. Collection note
.. note::
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To use it in a playbook, specify: :code:`redhat.satellite.foreman_architecture`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ redhat.satellite.foreman_auth_source_ldap module
.. Collection note
.. note::
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To use it in a playbook, specify: :code:`redhat.satellite.foreman_auth_source_ldap`.

Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/foreman_bookmark_module.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ redhat.satellite.foreman_bookmark module
.. Collection note
.. note::
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To use it in a playbook, specify: :code:`redhat.satellite.foreman_bookmark`.

Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/plugins/foreman_callback.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ redhat.satellite.foreman callback -- Sends events to Foreman
.. Collection note
.. note::
This callback plugin is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This callback plugin is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
You need further requirements to be able to use this callback plugin,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ redhat.satellite.foreman_compute_attribute module
.. Collection note
.. note::
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To use it in a playbook, specify: :code:`redhat.satellite.foreman_compute_attribute`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ redhat.satellite.foreman_compute_profile module
.. Collection note
.. note::
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To use it in a playbook, specify: :code:`redhat.satellite.foreman_compute_profile`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ redhat.satellite.foreman_compute_resource module
.. Collection note
.. note::
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.10.0).
This redirect is part of the `redhat.satellite collection <https://galaxy.ansible.com/redhat/satellite>`_ (version 3.11.0).

To use it in a playbook, specify: :code:`redhat.satellite.foreman_compute_resource`.

Expand Down
Loading

0 comments on commit 39478c4

Please sign in to comment.