Skip to content

Commit a418df2

Browse files
authored
docs: Update community docs (#742)
1 parent d408a47 commit a418df2

File tree

9 files changed

+123
-106
lines changed

9 files changed

+123
-106
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,32 @@ title: ""
55
labels: ""
66
assignees: ""
77
---
8+
> [!WARNING]
9+
> Remember to redact any sensitive information such as authentication credentials or license keys.
810
911
### Describe the bug
1012

11-
A clear and concise description of what the bug is.
13+
A clear and concise description of what the bug is: <...>
1214

1315
### To reproduce
1416

15-
Steps to reproduce the behavior:
17+
Steps to reproduce the bug:
1618

17-
1. Deploy the Ansible NGINX role using `playbook.yml`
18-
2. View output/logs/configuration on ...
19-
3. See error
19+
1. I have deployed/run the Ansible NGINX role using the following `playbook.yml`: <...>
20+
2. I have seen the following error(s) on my terminal output/logs: <...>
2021

2122
### Expected behavior
2223

23-
A clear and concise description of what you expected to happen.
24+
A clear and concise description of what you expected to happen: <...>
2425

2526
### Your environment
2627

27-
- Version of the Ansible NGINX role or specific commit
28-
- Version of Ansible
29-
- Version of Jinja2 (if you are using any templating capability)
30-
- Target deployment platform
28+
- Version of the Ansible NGINX role (or specific commit): <...>
29+
- Version of Ansible: <...>
30+
- Version of Jinja2 (if you are using any templating capability): <...>
31+
- How is Ansible being managed (CLI/pipeline/Automation Hub/etc...): <...>
32+
- Target deployment platform(s): <...>
3133

32-
### Additional context
34+
### Additional context (optional)
3335

3436
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,18 @@ title: ""
55
labels: ""
66
assignees: ""
77
---
8-
98
### Is your feature request related to a problem? Please describe
109

11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when ...
10+
A clear and concise description of what the problem is (e.g. I'm always frustrated when ...): <...>
1211

1312
### Describe the solution you'd like
1413

15-
A clear and concise description of what you want to happen.
14+
A clear and concise description of what you would like to happen.
1615

1716
### Describe alternatives you've considered
1817

19-
A clear and concise description of any alternative solutions or features you've considered.
18+
A clear and concise description of any alternative solutions you've considered.
2019

21-
### Additional context
20+
### Additional context (optional)
2221

2322
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
### Proposed changes
22

3-
Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue using one of the [supported keywords](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) here in this description (not in the title of the PR).
3+
Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue using one of the [supported keywords](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) in this PR's description or commit message.
44

55
### Checklist
66

77
Before creating a PR, run through this checklist and mark each as complete:
88

9-
- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/ansible-role-nginx/blob/main/CONTRIBUTING.md) document.
10-
- [ ] I have added Molecule tests that prove my fix is effective or that my feature works.
11-
- [ ] I have checked that any relevant Molecule tests pass after adding my changes.
12-
- [ ] I have updated any relevant documentation ([`defaults/main/*.yml`](https://github.com/nginxinc/ansible-role-nginx/blob/main/defaults/main/), [`README.md`](https://github.com/nginxinc/ansible-role-nginx/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/nginxinc/ansible-role-nginx/blob/main/CHANGELOG.md)).
9+
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md).
10+
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md).
11+
- [ ] If applicable, I have added Molecule tests that prove my fix is effective or that my feature works.
12+
- [ ] If applicable, I have checked that any relevant Molecule tests pass after adding my changes.
13+
- [ ] I have updated any relevant documentation ([`defaults/main/*.yml`](/defaults/main/), [`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md)).

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ FEATURES:
1111

1212
- Add support for installing NGINX Open Source on Alpine Linux 3.20.
1313

14+
DOCUMENTATION:
15+
16+
- Update community docs per the latest [NGINX template repository](https://github.com/nginxinc/template-repository) guidelines.
17+
1418
CI/CD:
1519

1620
- Update GitHub Actions to Ubuntu 24.04.

CODE_OF_CONDUCT.md

Lines changed: 54 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,70 +2,77 @@
22

33
## Our Pledge
44

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, sex characteristics, gender identity and expression,
9-
level of experience, education, socio-economic status, nationality, personal
10-
appearance, race, religion, or sexual identity and orientation.
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
118

129
## Our Standards
1310

14-
Examples of behavior that contributes to creating a positive environment
15-
include:
11+
Examples of behavior that contributes to a positive environment for our community include:
1612

17-
- Using welcoming and inclusive language
18-
- Being respectful of differing viewpoints and experiences
19-
- Gracefully accepting constructive criticism
20-
- Focusing on what is best for the community
21-
- Showing empathy towards other community members
13+
- Demonstrating empathy and kindness toward other people.
14+
- Being respectful of differing opinions, viewpoints, and experiences.
15+
- Giving and gracefully accepting constructive feedback.
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
17+
- Focusing on what is best not just for us as individuals, but for the overall community.
2218

23-
Examples of unacceptable behavior by participants include:
19+
Examples of unacceptable behavior include:
2420

25-
- The use of sexualized language or imagery and unwelcome sexual attention or advances
26-
- Trolling, insulting/derogatory comments, and personal or political attacks
27-
- Public or private harassment
28-
- Publishing others' private information, such as a physical or electronic address, without explicit permission
29-
- Other conduct which could reasonably be considered inappropriate in a professional setting
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind.
22+
- Trolling, insulting or derogatory comments, and personal or political attacks.
23+
- Public or private harassment.
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission.
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting.
3026

31-
## Our Responsibilities
27+
## Enforcement Responsibilities
3228

33-
Project maintainers are responsible for clarifying the standards of acceptable
34-
behavior and are expected to take appropriate and fair corrective action in
35-
response to any instances of unacceptable behavior.
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
3630

37-
Project maintainers have the right and responsibility to remove, edit, or
38-
reject comments, commits, code, wiki edits, issues, and other contributions
39-
that are not aligned to this Code of Conduct, or to ban temporarily or
40-
permanently any contributor for other behaviors that they deem inappropriate,
41-
threatening, offensive, or harmful.
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
4232

4333
## Scope
4434

45-
This Code of Conduct applies both within project spaces and in public spaces
46-
when an individual is representing the project or its community. Examples of
47-
representing a project or community include using an official project e-mail
48-
address, posting via an official social media account, or acting as an appointed
49-
representative at an online or offline event. Representation of a project may be
50-
further defined and clarified by project maintainers.
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
5136

5237
## Enforcement
5338

54-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
55-
reported by contacting the project team at <[email protected]>. All
56-
complaints will be reviewed and investigated and will result in a response that
57-
is deemed necessary and appropriate to the circumstances. The project team is
58-
obligated to maintain confidentiality with regard to the reporter of an incident.
59-
Further details of specific enforcement policies may be posted separately.
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <[email protected]>. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
6054

61-
Project maintainers who do not follow or enforce the Code of Conduct in good
62-
faith may face temporary or permanent repercussions as determined by other
63-
members of the project's leadership.
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
6470

6571
## Attribution
6672

67-
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
68-
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
73+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
74+
75+
Community Impact Guidelines were inspired by
76+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).
6977

70-
For answers to common questions about this code of conduct, see
71-
<https://www.contributor-covenant.org/faq>
78+
For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

0 commit comments

Comments
 (0)