Skip to content

Commit

Permalink
Various spelling corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
MallocArray committed Dec 11, 2024
1 parent 1871e23 commit e7d45d3
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/CONVERSION_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Red Hat Communties of Practice Controller Configuration Collection Conversion Guide
# Red Hat Communities of Practice Controller Configuration Collection Conversion Guide

## REQUIREMENTS

Expand Down
4 changes: 2 additions & 2 deletions roles/controller_license/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ controller_configuration_license_secure_logging defaults to the value of aap_con

The module and this role can use either a manifest file, or lookup the subscription on your account. Only one method is needed, provide the appropriate variables to use the either method.

### License Variables for using mainfest
### License Variables for using manifest

|Variable Name|Default Value|Required|Type|Description|
|:---:|:---:|:---:|:---:|:---:|
Expand All @@ -68,7 +68,7 @@ The module and this role can use either a manifest file, or lookup the subscript
|:---:|:---:|:---:|:---:|:---:|
|`filters`|"default values"|no|str|dict of filters to use to narrow the subscription. See example below for how to use this.|
|`support_level`|"Self-Support"|no|str|DEPRECATED - changed to `manifest_file` (still works as an alias)|
|`list_num`|0|no|int|List index of the subscription to use, if you want to overide the default, it is recommended to use the filters to limit the pools found.|
|`list_num`|0|no|int|List index of the subscription to use, if you want to override the default, it is recommended to use the filters to limit the pools found.|
|`pool_id`|""|no|str|Red Hat or Red Hat Satellite pool_id to attach to.|
|`force`|`false`|no|bool|By default, the license will only be applied if controller is currently unlicensed or trial licensed. When force=true, the license is always applied.|
|`use_lookup`|`false`|no|bool|Whether or not to lookup subscriptions.|
Expand Down
2 changes: 1 addition & 1 deletion roles/controller_organizations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ This role accepts two data models. A simple straightforward easy to maintain mod
|`custom_virtualenv`|""|no|str|Local absolute file path containing a custom Python virtualenv to use.|
|`max_hosts`|""|no|int|The max hosts allowed in this organization.|
|`instance_groups`|""|no|list|list of Instance Groups for this Organization to run on.|
|`galaxy_credentials`|""|no|list|The credentials to use with private automationhub.|
|`galaxy_credentials`|""|no|list|The credentials to use with private automation hub.|
|`default_environment`|""|no|str|Default Execution Environment to use for jobs owned by the Organization.|
|`notification_templates_started`|""|no|list|The notifications on started to use for this organization in a list.|
|`notification_templates_success`|""|no|list|The notifications on success to use for this organization in a list.|
Expand Down
2 changes: 1 addition & 1 deletion roles/gateway_routes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Options for the `routes_list` variable:
| `service_path` | N/A | no | str | URL path on the AAP Service cluster to route traffic to |
| `service_port` | N/A | no | int | Port on the service cluster to route traffic to |
| `tags` | "" | no | str | Comma-separated string, selects which (tagged) nodes receive traffic from this route|
| `state` | `present` | no | str | README.md#state-variable) |
| `state` | `present` | no | str | README.md#state-variable |

**Unique value:**

Expand Down
2 changes: 1 addition & 1 deletion roles/hub_collection_remote/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ This also speeds up the overall role.
|`auth_url`|`https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token`|no|(`ah_repository_certified`)Remote URL for the repository authentication if separate.||
|`token`|``|no|Token to authenticate to the remote repository.||
|`policy`|`immediate`|no|The policy to use when downloading content. Can be one of `immediate`, `When syncing, download all metadata and content now.`.||
|`requirements`|``|no|Requirements, a list of collections in [requirements file format](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html#install-multiple-collections-with-a-requirements-file) to limit thedownload from remote. This will only download provided collections. This is only the list under collections. See examples for usage.||
|`requirements`|``|no|Requirements, a list of collections in [requirements file format](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html#install-multiple-collections-with-a-requirements-file) to limit the download from remote. This will only download provided collections. This is only the list under collections. See examples for usage.||
|`requirements_file`|``|no|A yaml requirements file to download from remote. In requirements file format. Exclusive with `requirements` ||
|`username`|``|no|Username to authenticate to the remote repository.||
|`password`|``|no|Password to authenticate to the remote repository.||
Expand Down
2 changes: 1 addition & 1 deletion roles/hub_ee_registry_sync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ An Ansible Role to sync EE Registries in Automation Hub.
|`aap_request_timeout`|`10`|no|Specify the timeout Ansible should use in requests to the Galaxy or Automation Hub host.||
|`ah_path_prefix`|""|no|API path used to access the api. Either galaxy, automation-hub, or custom||
|`aap_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.||
|`hub_ee_registries`|`see below`|yes|Data structure describing your ee_registries, described below. (Note this is the same as for the `ee_registries` role and the variable can be combined. Note that this role will only do anything if the `sync` suboption of this variable is set to true.||
|`hub_ee_registries`|`see below`|yes|Data structure describing your ee_registries, described below. (Note this is the same as for the `ee_registries` role and the variable can be combined. Note that this role will only do anything if the `sync` sub-option of this variable is set to true.)||

### Secure Logging Variables

Expand Down
2 changes: 1 addition & 1 deletion roles/hub_ee_repository_sync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ An Ansible Role to sync EE Repositories in Automation Hub.
|`aap_request_timeout`|`10`|no|Specify the timeout Ansible should use in requests to the Galaxy or Automation Hub host.||
|`ah_path_prefix`|""|no|API path used to access the api. Either galaxy, automation-hub, or custom||
|`aap_configuration_async_dir`|`null`|no|Sets the directory to write the results file for async tasks. The default value is set to `null` which uses the Ansible Default of `/root/.ansible_async/`.||
|`hub_ee_repositories`|`see below`|yes|Data structure describing your ee_repositories, described below. (Note this is the same as for the `ee_repository` role and the variable can be combined. Note that this role will only do anything if the `sync` suboption of this variable is set to true.||
|`hub_ee_repositories`|`see below`|yes|Data structure describing your ee_repositories, described below. (Note this is the same as for the `ee_repository` role and the variable can be combined. Note that this role will only do anything if the `sync` sub-option of this variable is set to true.)||

### Secure Logging Variables

Expand Down
6 changes: 3 additions & 3 deletions roles/hub_group_roles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ This also speeds up the overall role.
#### role_list

The `role_list` variable is a combination of roles and targets that are applied to the groups listed in `groups`.
The structure look slike
The structure looks like

```yaml
- roles:
Expand All @@ -81,7 +81,7 @@ Targets consist of the following.
|`collection_remotes`|List of collection remotes to apply the roles to.|
|`collection_repositories`|List of collection repositories to apply the roles to.|
|`execution_environments`|List of execution environments to apply the roles to.|
|`container_registery_remotes`|List of container registry remotes to apply the roles to.|
|`container_registry_remotes`|List of container registry remotes to apply the roles to.|

#### Yaml Example

Expand All @@ -101,7 +101,7 @@ hub_group_roles:
- roles:
- galaxy.container_remote
targets:
container_registery_remotes:
container_registry_remotes:
- quay
- roles:
- galaxy.user_admin
Expand Down
2 changes: 1 addition & 1 deletion roles/hub_namespace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ This also speeds up the overall role.
|Variable Name|Default Value|Required|Type|Description|
|:---:|:---:|:---:|:---:|:---:|
|`name`|""|yes|str|Namespace name. Must be lower case containing only alphanumeric characters and underscores.|
|`new_name`|""|yes|str|Setting this option will change the existing name (looked up via the name field.|
|`new_name`|""|yes|str|Setting this option will change the existing name (looked up via the name field.)|
|`description`|""|yes|str|Description to use for the Namespace.|
|`company`|""|no|str|Namespace owner company name.|
|`email`|"password"|yes|str|Namespace contact email.|
Expand Down

0 comments on commit e7d45d3

Please sign in to comment.