Skip to content

Commit 0212fd0

Browse files
committed
Add note about Collection Metadata usage and update callout formatting
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
1 parent 9650c55 commit 0212fd0

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

.github/workflows/validate_pr.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ on:
2020
branches:
2121
- 'release/**'
2222
- 'devel'
23-
- 'devel-pvc-base'
2423

2524
jobs:
2625
validate:

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ As a _best practice_, you can prefix your branches with:
1818
|`fix/`|A non-urgent bug fix|`fix/refactor-module-output-params`|
1919
|`hotfix/`|An urgent bug fix|`hotfix/patch-insecure-module`|
2020

21-
:fire_extinguisher: **NOTE:** a **hotfix** should branch from `main`. It will then be committed to both the `main` and `devel` branches.
21+
> [!NOTE]
22+
> :fire_extinguisher: **NOTE:** a **hotfix** should branch from `main`. It will then be committed to both the `main` and `devel` branches.
2223
2324
## Signing your commits
2425

@@ -73,7 +74,8 @@ To agree, make sure to add line at the end of every git commit message, like thi
7374
Signed-off-by: John Doe <jdoe@example.com>
7475
```
7576

76-
:rocket: TIP! Add the sign-off automatically when creating the commit via the `-s` flag, e.g. `git commit -s`.
77+
> [!NOTE]
78+
> :rocket: TIP! Add the sign-off automatically when creating the commit via the `-s` flag, e.g. `git commit -s`.
7779
7880
## Still have questions? Opinions? Comments?
7981

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ See [Building the Collection](#building-the-collection) for details on creating
9595

9696
The `cloudera.exe` expects `ansible-core>=2.10,<2.13`.
9797

98-
> **WARNING:** The current functionality of the `cloudera.cluster` dependency does not yet work with Ansible version `2.13` and later.
98+
> [!WARNING]
99+
> The current functionality of the `cloudera.cluster` dependency does not yet work with Ansible version `2.13` and later.
99100
100101
The collection has the following _required_ dependencies:
101102

@@ -164,6 +165,8 @@ All collection dependencies, required and optional, can be found in `requirement
164165

165166
`ansible-builder` can discover and install all Python dependencies - current collection and dependencies - if you wish to use that application to construct your environment. Otherwise, you will need to read each collection and role dependency and follow its installation instructions.
166167

168+
See the [Collection Metadata](https://ansible.readthedocs.io/projects/builder/en/latest/collection_metadata/) section for further details on how to install (and manage) collection dependencies.
169+
167170
You may wish to use a _virtual environment_ to manage the Python dependencies.
168171

169172
## Using the Collection
@@ -196,11 +199,13 @@ For example, here we use the
196199
ansible.builtin.import_playbook: cloudera.exe.pbc_setup.yml
197200
```
198201
199-
> **NOTE:** You **must** run `cloudera.exe.init_deployment` before calling any of the collection's playbooks. This call must occur within the source project, otherwise Ansible's `playbook_dir` will change to the collection's installation directory and variable lookups might not work as expected.
202+
> [!IMPORTANT]
203+
> You **must** run `cloudera.exe.init_deployment` before calling any of the collection's playbooks. This call must occur within the source project, otherwise Ansible's `playbook_dir` will change to the collection's installation directory and variable lookups might not work as expected.
200204

201205
### Legacy Execution Modes
202206

203-
> **WARNING:** These documents and their modes of operation are deprecated in version 2.x. For example, the use of Ansible tags to trigger coarse runlevels have been replaced by explicit playbook execution. However, the "inner" tag structures still remain and might be relevant to some execution modes.
207+
> [!WARNING]
208+
> These documents and their modes of operation are deprecated in version 2.x. For example, the use of Ansible tags to trigger coarse runlevels have been replaced by explicit playbook execution. However, the "inner" tag structures still remain and might be relevant to some execution modes.
204209

205210
See the [execution examples](docs/runlevels.md#execution) in the Deployment Runlevels document.
206211

0 commit comments

Comments
 (0)