Skip to content

Commit 2024ad7

Browse files
committed
Add note about Collection Metadata usage and update callout formatting
Signed-off-by: Webster Mudge <[email protected]>
1 parent 9b85c79 commit 2024ad7

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
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: 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 <[email protected]>
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: 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: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ See [Building the Collection](#building-the-collection) for details on creating
7777

7878
`cloudera.cluster` expects `ansible-core>=2.10,<2.13`.
7979

80-
> **WARNING:** The current `import_template` functionality does not yet work with Ansible version `2.13` and later.
80+
> [!WARNING]
81+
> The current `import_template` functionality does not yet work with Ansible version `2.13` and later.
8182
8283
The collection has the following _required_ dependencies:
8384

@@ -108,6 +109,8 @@ All collection dependencies, required and optional, can be found in `requirement
108109

109110
`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.
110111

112+
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.
113+
111114
You may wish to use a _virtual environment_ to manage the Python dependencies.
112115

113116
See the `base` *Execution Environment* configuration in [`cloudera-labs/cldr-runner`](https://github.com/cloudera-labs/cldr-runner) as an example of how you can install the optional dependencies to suit your specific needs.
@@ -179,6 +182,9 @@ Your local documentation will be found at `docsbuild/build/html`.
179182

180183
Active development is focused on **CDP Private Cloud** deployments and their respective platform compatibility matrices.
181184

185+
> [!NOTE]
186+
> While the collection's plugins and roles can be used to deploy CDH 5.x and CDH 6.x environments, it is only possible to install a subset of their supported platform components (i.e JDK and database versions) using this tooling.
187+
182188
### Cloudera Distributions
183189

184190
- Cloudera Manager / CDP Private Cloud Base 7.1.x
@@ -193,11 +199,10 @@ Active development is focused on **CDP Private Cloud** deployments and their res
193199
- Ubuntu 18.04 LTS (Bionic Beaver)
194200
- Ubuntu 20.04 LTS (Focal Fossa)
195201

196-
> While the collection's plugins and roles can be used to deploy CDH 5.x and CDH 6.x environments, it is only possible to install a subset of their supported platform components (i.e JDK and database versions) using this tooling.
197-
198202
## Operational Features
199203

200-
> **NOTE:** These operational features are deprecated as of version 4.x. If you want to use or build similar features and functions, head over to the [Discussions](https://github.com/cloudera-labs/cloudera.cluster/discussions) to learn more about using the collection to achieve your platform operations needs.
204+
> [!WARNING]
205+
> These operational features are deprecated as of version 4.x. If you want to use or build similar features and functions, head over to the [Discussions](https://github.com/cloudera-labs/cloudera.cluster/discussions) to learn more about using the collection to achieve your platform operations needs.
201206
202207
This collection includes support for:
203208

0 commit comments

Comments
 (0)