Skip to content

Commit ef7d10c

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

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

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 <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: 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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ The collection's Python dependencies alone, _not_ the required Python libraries
9191

9292
`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.
9393

94+
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.
95+
9496
You may wish to use a _virtual environment_ to manage the Python dependencies.
9597

9698
## Using the Collection
@@ -113,10 +115,8 @@ For example, here we use the
113115
ansible.builtin.debug:
114116
var: output
115117
```
116-
117-
> **NOTE:** The CDP modules expect standard CDP authentication configurations,
118-
e.g. `CDP_PROFILE`, as described by the *Configuring* section of
119-
[CDP CLI/SDK](https://github.com/cloudera/cdpcli#configuring).
118+
> [!IMPORTANT]
119+
> The CDP modules expect standard CDP authentication configurations, e.g. `CDP_PROFILE`, as described by the *Configuring* section of [CDP CLI/SDK](https://github.com/cloudera/cdpcli#configuring).
120120

121121
## Building the Collection
122122

meta/runtime.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22

3-
# Copyright 2021 Cloudera, Inc. All Rights Reserved.
3+
# Copyright 2023 Cloudera, Inc. All Rights Reserved.
44
#
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.
@@ -14,4 +14,6 @@
1414
# See the License for the specific language governing permissions and
1515
# limitations under the License.
1616

17-
requires_ansible: ">=2.10"
17+
requires_ansible: ">=2.10"
18+
19+
# action_groups: {}

0 commit comments

Comments
 (0)