Skip to content

Commit c5efbb2

Browse files
authored
Add Ansible documentation generation resources and workflows (#151)
* Add Ansible documentation build resources * Add Ansible documentation linting and construction workflows * Update cloudera.exe.combine_onto filter docs * Update to use fully-qualified filter name * Update docs for top links, Github edits, and extra links * Add CONTRIBUTING document * Remove old CSP requirements (superseded by EE configurations in cldr-runner) * Update Python dependencies * Add missing requirements.yml convenience file * Update galaxy.yml to add cloudera.cluster dependency, docs link, tags, and general formatting * Refactor README to align content with planned release * Add note about Collection Metadata usage and update callout formatting Signed-off-by: Webster Mudge <[email protected]>
1 parent 6b0233e commit c5efbb2

21 files changed

+607
-179
lines changed

.github/workflows/publish_docs.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
3+
name: Publish documentation
4+
5+
on:
6+
push:
7+
branches:
8+
- 'main'
9+
10+
workflow_dispatch:
11+
12+
jobs:
13+
build-ansible-docs:
14+
name: Build Ansible Docs
15+
uses: cloudera-labs/github-actions/.github/workflows/construct-ansible-docs.yml@v1
16+
with:
17+
pages-upload: true
18+
directory-upload: true
19+
antsibull-log-upload: true
20+
21+
publish-ansible-docs:
22+
name: Publish Ansible Docs
23+
needs: build-ansible-docs
24+
runs-on: ubuntu-latest
25+
permissions:
26+
pages: write
27+
id-token: write
28+
environment:
29+
name: github-pages
30+
url: ${{ steps.deployment.outputs.page_url }}
31+
steps:
32+
- name: Deploy Github Pages
33+
id: deployment
34+
uses: actions/deploy-pages@v2
35+
with:
36+
artifact_name: github-pages

.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:
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
3+
name: Validate Pull Request documentation
4+
5+
on:
6+
pull_request:
7+
branches:
8+
- 'release/**'
9+
- 'devel'
10+
11+
workflow_dispatch:
12+
13+
jobs:
14+
validate-docs:
15+
name: Validate Ansible Docs
16+
uses: cloudera-labs/github-actions/.github/workflows/lint-ansible-docs.yml@v1
17+
with:
18+
antsibull-log-upload: true
19+
collection-namespace: cloudera
20+
collection-name: exe

CONTRIBUTING.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Contributing to cloudera.exe
2+
3+
Thank you for considering contributions to the `cloudera.exe` Ansible collection!
4+
5+
## Submitting a pull request
6+
7+
You can start work on issues that are not yet part of a [Milestone](https://github.com/cloudera-labs/cloudera.exe/milestones) -- anything in our issue tracker that isn't assigned to a Milestone is considered the [backlog](https://github.com/cloudera-labs/cloudera.exe/issues?q=is%3Aopen+is%3Aissue+no%3Amilestone).
8+
9+
Before you start working, please announce that you want to do so by commenting on the issue. _([Create an issue](https://github.com/cloudera-labs/cloudera.exe/issues/new?labels=enhancement) if there isn't one yet, and you can also check out our [Discussions](https://github.com/cloudera-labs/cloudera.exe/discussions) for ideas.)_ We try to ensure that all active work is assigned to a Milestone in order to keep our backlog accurate.
10+
11+
**When your work is ready for review, create a branch in your own forked repository from the `devel` branch and submit a pull request against `devel`, referencing your the issue.**
12+
13+
As a _best practice_, you can prefix your branches with:
14+
15+
|prefix|Description|Example|
16+
|------|-----------|-------|
17+
|`feature/`|A new feature or changes existing to existing code or documentation|`feature/update-this-modules-params`|
18+
|`fix/`|A non-urgent bug fix|`fix/refactor-module-output-params`|
19+
|`hotfix/`|An urgent bug fix|`hotfix/patch-insecure-module`|
20+
21+
> [!NOTE]
22+
> :fire_extinguisher: A **hotfix** should branch from `main`. It will then be committed to both the `main` and `devel` branches.
23+
24+
## Signing your commits
25+
26+
Note that we require signed commits inline with [Developer Certificate of Origin](https://developercertificate.org/) best-practices for open source collaboration.
27+
28+
A signed commit is a simple one-liner at the end of your commit message that states that you wrote the patch or otherwise have the right to pass the change into open source. Signing your commits means you agree to:
29+
30+
```
31+
Developer Certificate of Origin
32+
Version 1.1
33+
34+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
35+
660 York Street, Suite 102,
36+
San Francisco, CA 94110 USA
37+
38+
Everyone is permitted to copy and distribute verbatim copies of this
39+
license document, but changing it is not allowed.
40+
41+
42+
Developer's Certificate of Origin 1.1
43+
44+
By making a contribution to this project, I certify that:
45+
46+
(a) The contribution was created in whole or in part by me and I
47+
have the right to submit it under the open source license
48+
indicated in the file; or
49+
50+
(b) The contribution is based upon previous work that, to the best
51+
of my knowledge, is covered under an appropriate open source
52+
license and I have the right under that license to submit that
53+
work with modifications, whether created in whole or in part
54+
by me, under the same open source license (unless I am
55+
permitted to submit under a different license), as indicated
56+
in the file; or
57+
58+
(c) The contribution was provided directly to me by some other
59+
person who certified (a), (b) or (c) and I have not modified
60+
it.
61+
62+
(d) I understand and agree that this project and the contribution
63+
are public and that a record of the contribution (including all
64+
personal information I submit with it, including my sign-off) is
65+
maintained indefinitely and may be redistributed consistent with
66+
this project or the open source license(s) involved.
67+
```
68+
69+
(See [developercertificate.org](https://developercertificate.org/))
70+
71+
To agree, make sure to add line at the end of every git commit message, like this:
72+
73+
```
74+
Signed-off-by: John Doe <[email protected]>
75+
```
76+
77+
> [!NOTE]
78+
> :rocket: TIP! Add the sign-off automatically when creating the commit via the `-s` flag, e.g. `git commit -s`.
79+
80+
## Still have questions? Opinions? Comments?
81+
82+
Come find us on our [Discussions](https://github.com/cloudera-labs/cloudera.exe/discussions)!

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright 2021 Cloudera, Inc.
189+
Copyright 2023 Cloudera, Inc.
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)