Skip to content

Commit 3d9613a

Browse files
committedMar 18, 2025··
docs: Update community files
1 parent 66df4d8 commit 3d9613a

12 files changed

+217
-140
lines changed
 

‎.github/CODEOWNERS

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#####################
2+
# Main global owner #
3+
#####################
4+
5+
* @thresheek
6+

‎.github/ISSUE_TEMPLATE/bug_report.md

-33
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: 🐛 Bug report
3+
description: Create a report to help us improve
4+
labels: bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
Before you continue filling out this report, please take a moment to check that your bug has not been [already reported on GitHub][issue search] 🙌
12+
13+
Remember to redact any sensitive information such as authentication credentials and/or license keys!
14+
15+
[issue search]: ../search?q=is%3Aissue&type=issues
16+
17+
- type: textarea
18+
id: overview
19+
attributes:
20+
label: Bug Overview
21+
description: A clear and concise overview of the bug.
22+
placeholder: When I do "X" with the NGINX Docker image, "Y" happens instead of "Z".
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: behavior
28+
attributes:
29+
label: Expected Behavior
30+
description: A clear and concise description of what you expected to happen.
31+
placeholder: When I do "X" with the NGINX Docker image, I expect "Z" to happen.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: steps
37+
attributes:
38+
label: Steps to Reproduce the Bug
39+
description: Detail the series of steps required to reproduce the bug.
40+
placeholder: When I run the Docker NGINX image using [...], the image fails with an error message. If I check the terminal outputs and/or logs, I see the following error info.
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: environment
46+
attributes:
47+
label: Environment Details
48+
description: Please provide details about your environment.
49+
value: |
50+
- Version/release of Docker and method of installation (e.g. Docker Desktop / Docker Server)
51+
- Version of the Docker NGINX image or specific commit: [e.g. 1.4.3/commit hash]
52+
- Target deployment platform: [e.g. OpenShift/Kubernetes/Docker Compose/local cluster/etc...]
53+
- Target OS: [e.g. RHEL 9/Ubuntu 24.04/etc...]
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: context
59+
attributes:
60+
label: Additional Context
61+
description: Add any other context about the problem here.
62+
placeholder: Feel free to add any other context/information/screenshots/etc... that you think might be relevant to this issue in here.

‎.github/ISSUE_TEMPLATE/config.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 💬 Talk to the NGINX community!
5+
url: https://community.nginx.org
6+
about: A community forum for NGINX users, developers, and contributors
7+
- name: 📝 Code of Conduct
8+
url: https://www.contributor-covenant.org/version/2/1/code_of_conduct
9+
about: NGINX follows the Contributor Covenant Code of Conduct to ensure a safe and inclusive community
10+
- name: 💼 For commercial & enterprise users
11+
url: https://www.f5.com/products/nginx
12+
about: F5 offers a wide range of NGINX products for commercial & enterprise users

‎.github/ISSUE_TEMPLATE/feature_request.md

-23
This file was deleted.
+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: ✨ Feature request
3+
description: Suggest an idea for this project
4+
labels: enhancement
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this feature request!
10+
11+
Before you continue filling out this request, please take a moment to check that your feature has not been [already requested on GitHub][issue search] 🙌
12+
13+
**Note:** If you are seeking community support or have a question, please consider starting a new thread via [GitHub discussions][discussions] or the [NGINX Community forum][forum].
14+
15+
[issue search]: ../search?q=is%3Aissue&type=issues
16+
17+
[discussions]: ../discussions
18+
[forum]: https://community.nginx.org
19+
20+
- type: textarea
21+
id: overview
22+
attributes:
23+
label: Feature Overview
24+
description: A clear and concise description of what the feature request is.
25+
placeholder: I would like the Docker NGINX image to be able to do "X".
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Detail any potential alternative solutions/workarounds you've used or considered.
34+
placeholder: I have done/might be able to do "X" in the Docker NGINX image by doing "Y".
35+
36+
- type: textarea
37+
id: context
38+
attributes:
39+
label: Additional Context
40+
description: Add any other context about the problem here.
41+
placeholder: Feel free to add any other context/information/screenshots/etc... that you think might be relevant to this feature request here.

‎.github/pull_request_template.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
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:
8-
- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginx/docker-nginx/blob/master/CONTRIBUTING.md) document
8+
9+
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
10+
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md)
911
- [ ] I have run `./update.sh` and ensured all entrypoint/Dockerfile template changes have been applied to the relevant image entrypoint scripts & Dockerfiles
1012
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
1113
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
12-
- [ ] I have updated any relevant documentation
14+
- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and/or [`modules/README.md`](/modules/README.md))

‎CODE_OF_CONDUCT.md

+54-50
Original file line numberDiff line numberDiff line change
@@ -2,73 +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
26-
advances
27-
- Trolling, insulting/derogatory comments, and personal or political attacks
28-
- Public or private harassment
29-
- Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
- Other conduct which could reasonably be considered inappropriate in a
32-
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.
3326

34-
## Our Responsibilities
27+
## Enforcement Responsibilities
3528

36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
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.
3930

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
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.
4532

4633
## Scope
4734

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
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.
5436

5537
## Enforcement
5638

57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the moderation team at <nginx-oss-community@f5.com>. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
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 <nginx-oss-community@f5.com>. 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
6354

64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
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.
6770

6871
## Attribution
6972

70-
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
71-
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).
7277

73-
For answers to common questions about this code of conduct, see
74-
<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>.

‎CONTRIBUTING.md

+16-13
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,10 @@ The following is a set of guidelines for contributing to the Docker NGINX image.
44

55
#### Table Of Contents
66

7-
[Getting Started](#getting-started)
8-
9-
[Contributing](#contributing)
10-
11-
[Code Guidelines](#code-guidelines)
12-
13-
[Code of Conduct](https://github.com/nginx/docker-nginx/blob/master/CODE_OF_CONDUCT.md)
7+
- [Getting Started](#getting-started)
8+
- [Contributing](#contributing)
9+
- [Code Guidelines](#code-guidelines)
10+
- [Code of Conduct](/CODE_OF_CONDUCT.md)
1411

1512
## Getting Started
1613

@@ -20,18 +17,24 @@ Follow our [how to use this image guide](https://hub.docker.com/_/nginx/) to get
2017

2118
### Report a Bug
2219

23-
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](https://github.com/nginx/docker-nginx/blob/master/SECURITY.md).**
20+
To report a bug, open an issue on GitHub with the label `bug` using the available [bug report issue form](/.github/ISSUE_TEMPLATE/bug_report.yml). Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](/SECURITY.md).**
2421

2522
### Suggest a Feature or Enhancement
2623

27-
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](https://github.com/nginx/docker-nginx/blob/master/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.
24+
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request issue form](/.github/ISSUE_TEMPLATE/feature_request.yml). Please ensure the feature or enhancement has not already been suggested.
25+
26+
### Open a Pull Request (PR)
27+
28+
- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are **tested** and ready for review.
29+
- Fill in the [PR template](/.github/pull_request_template.md).
30+
31+
**Note:** If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/ISSUE_TEMPLATE/feature_request.yml) first to start a discussion about the feature.
2832

29-
### Open a Pull Request
33+
#### F5 Contributor License Agreement (CLA)
3034

31-
- Fork the repo, create a branch, implement your changes, add any relevant tests, submit a PR when your changes are **tested** and ready for review.
32-
- Fill in [our pull request template](https://github.com/nginx/docker-nginx/blob/master/.github/pull_request_template.md).
35+
F5 requires all contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/f5-cla/.github/blob/main/docs/f5_cla.md)) before any of their changes can be incorporated into an F5 Open Source repository (even contributions to the F5 CLA itself!).
3336

34-
Note: if you'd like to implement a new feature, please consider creating a [feature request issue](https://github.com/nginx/docker-nginx/blob/master/.github/feature_request_template.md) first to start a discussion about the feature.
37+
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.
3538

3639
## Code Guidelines
3740

‎README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
22
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginx/docker-nginx/blob/master/SUPPORT.md)
3+
[![Community Forum](https://img.shields.io/badge/community-forum-009639?logo=discourse&link=https%3A%2F%2Fcommunity.nginx.org)](https://community.nginx.org)
4+
[![License](https://img.shields.io/badge/License-BSD_2--Clause-blue.svg)](https://opensource.org/license/bsd-2-clause)
5+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/CODE_OF_CONDUCT.md)
36

47
# About this Repo
58

@@ -19,13 +22,13 @@ For outstanding `nginx` image PRs, check [PRs with the "library/nginx" label on
1922

2023
## Contributing
2124

22-
Please see the [contributing guide](https://github.com/nginx/docker-nginx/blob/master/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
25+
Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
2326

2427
## License
2528

26-
[BSD 2-Clause](https://github.com/nginx/docker-nginx/blob/master/LICENSE)
29+
[BSD 2-Clause](/LICENSE)
2730

28-
&copy; [F5, Inc.](https://www.f5.com/) 2023
31+
&copy; [F5, Inc.](https://www.f5.com/) 2014-2025
2932

3033
---
3134

‎SECURITY.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ We advise users to run or update to the most recent release of the NGINX Docker
66

77
## Reporting a Vulnerability
88

9-
The F5 Security Incident Response Team (F5 SIRT) has an email alias that makes it easy to report potential security vulnerabilities.
9+
The F5 Security Incident Response Team (F5 SIRT) offers two methods to easily report potential security vulnerabilities:
1010

11-
- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).
12-
- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities with any F5 product to the F5 Security Incident Response Team at <F5SIRT@f5.com>.
11+
- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/support).
12+
- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities in any F5 product to the F5 Security Incident Response Team at <f5sirt@f5.com>.
1313

14-
For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability)
14+
For more information, please read the F5 SIRT vulnerability reporting guidelines available at [https://www.f5.com/support/report-a-vulnerability](https://www.f5.com/support/report-a-vulnerability).

‎SUPPORT.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@
22

33
## Ask a Question
44

5-
We use GitHub for tracking bugs and feature requests related to all the Docker NGINX images (including all variants and container registries).
5+
We use GitHub for tracking bugs and feature requests related to this project.
66

7-
Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please open an issue on GitHub with the label `question`.
7+
Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please open an issue on GitHub with the label `question`. Alternatively, start a GitHub discussion!
88

99
## NGINX Specific Questions and/or Issues
1010

1111
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
1212

13-
### Community Slack
13+
### Community Forum
1414

15-
We have a community [Slack](https://nginxcommunity.slack.com/)!
16-
17-
If you are not a member, click [here](https://community.nginx.org/joinslack) to sign up (and let us know if the link does not seem to be working!)
18-
19-
Once you join, check out the `#beginner-questions` and `nginx-users` channels :)
15+
We have a community [forum](https://community.nginx.org/)! If you have any questions and/or issues, try checking out the [`Troubleshooting`](https://community.nginx.org/c/troubleshooting/8) and [`How do I...?`](https://community.nginx.org/c/how-do-i/9) categories. Both fellow community members and NGINXers might be able to help you! :)
2016

2117
### Documentation
2218

2319
For a comprehensive list of all NGINX directives, check out <https://nginx.org>.
2420

25-
For a comprehensive list of admin and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
21+
For a comprehensive list of administration and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
2622

2723
### Mailing List
2824

2925
Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found at <https://mailman.nginx.org/mailman3/lists/>!
3026

3127
## Contributing
3228

33-
Please see the [contributing guide](https://github.com/nginx/docker-nginx/blob/master/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
29+
Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
3430

3531
## Commercial Support
3632

37-
Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.nginx.com/contact-sales/) or check your contract details for more info!
33+
Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.f5.com/products/get-f5/) or check your contract details for more information!
34+
35+
## Community Support
36+
37+
Community support is offered on a best effort basis through either GitHub issues/PRs/discussions or through any of our active communities.

0 commit comments

Comments
 (0)
Please sign in to comment.