-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: address PR feedback Move README section uptop Replace project with repo name where appropriate
- Loading branch information
Showing
9 changed files
with
188 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: "" | ||
labels: "" | ||
assignees: "" | ||
--- | ||
|
||
### Describe the bug | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
### To reproduce | ||
|
||
Steps to reproduce the behavior: | ||
|
||
1. Deploy the NGINX Docker image using ... | ||
2. View output/logs/configuration on ... | ||
3. See error | ||
|
||
### Expected behavior | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
### Your environment | ||
|
||
- Version/release of Docker and method of installation (e.g. Docker Desktop / Docker Server) | ||
- Version/tag of the NGINX Docker image (e.g. `nginx:alpine`) | ||
- Target deployment platform (e.g. OpenShift / Kubernetes / Docker Compose / etc...) | ||
|
||
### Additional context | ||
|
||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: "" | ||
labels: "" | ||
assignees: "" | ||
--- | ||
|
||
### Is your feature request related to a problem? Please describe | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when ... | ||
|
||
### Describe the solution you'd like | ||
|
||
A clear and concise description of what you want to happen. | ||
|
||
### Describe alternatives you've considered | ||
|
||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
### Additional context | ||
|
||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
### Proposed changes | ||
|
||
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). | ||
|
||
### Checklist | ||
|
||
Before creating a PR, run through this checklist and mark each as complete: | ||
- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/docker-nginx/blob/master/CONTRIBUTING.md) document | ||
- [ ] I have run `./update.sh` and ensured all entrypoint/Dockerfile template changes have been applied to the relevant image entrypoint scripts & Dockerfiles | ||
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works | ||
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes | ||
- [ ] I have updated any relevant documentation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing Guidelines | ||
|
||
The following is a set of guidelines for contributing to the Docker NGINX image. We really appreciate that you are considering contributing! | ||
|
||
#### Table Of Contents | ||
|
||
[Getting Started](#getting-started) | ||
|
||
[Contributing](#contributing) | ||
|
||
[Code Guidelines](#code-guidelines) | ||
|
||
[Code of Conduct](https://github.com/nginxinc/docker-nginx/blob/master/CODE_OF_CONDUCT.md) | ||
|
||
## Getting Started | ||
|
||
Follow our [how to use this image guide](https://hub.docker.com/_/nginx/) to get the Docker NGINX image up and running. | ||
|
||
## Contributing | ||
|
||
### Report a Bug | ||
|
||
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/nginxinc/docker-nginx/blob/master/SECURITY.md).** | ||
|
||
### Suggest a Feature or Enhancement | ||
|
||
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/nginxinc/docker-nginx/blob/master/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested. | ||
|
||
### Open a Pull Request | ||
|
||
- 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. | ||
- Fill in [our pull request template](https://github.com/nginxinc/docker-nginx/blob/master/.github/pull_request_template.md). | ||
|
||
Note: if you'd like to implement a new feature, please consider creating a [feature request issue](https://github.com/nginxinc/docker-nginx/blob/master/.github/feature_request_template.md) first to start a discussion about the feature. | ||
|
||
## Code Guidelines | ||
|
||
### Git Guidelines | ||
|
||
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR. | ||
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated | ||
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points: | ||
- In the subject line, use the present tense ("Add feature" not "Added feature"). | ||
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to..."). | ||
- Limit the subject line to 72 characters or less. | ||
- Reference issues and pull requests liberally after the subject line. | ||
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`). | ||
|
||
### Docker Guidelines | ||
|
||
- Update any entrypoint scripts via the the scripts contained in the `/entrypoint` directory. | ||
- Update any Dockerfiles via the Dockerfile templates in the root directory (e.g. `Dockerfile-alpine.template`). | ||
- Run the `./update.sh` script to apply all entrypoint/Dockerfile template changes to the relevant image entrypoints & Dockerfiles. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Security Policy | ||
|
||
## Latest Versions | ||
|
||
We advise users to run or update to the most recent release of the NGINX Docker image. Older versions of the NGINX Docker image may not have all enhancements and/or bug fixes applied to them. | ||
|
||
## Reporting a Vulnerability | ||
|
||
The F5 Security Incident Response Team (F5 SIRT) has an email alias that makes it easy to report potential security vulnerabilities. | ||
|
||
- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support). | ||
- 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>. | ||
|
||
For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Support | ||
|
||
## Ask a Question | ||
|
||
We use GitHub for tracking bugs and feature requests related to all the Docker NGINX images (including all variants and container registries). | ||
|
||
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`. | ||
|
||
## NGINX Specific Questions and/or Issues | ||
|
||
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding! | ||
|
||
### Community Slack | ||
|
||
We have a community [Slack](https://nginxcommunity.slack.com/)! | ||
|
||
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!) | ||
|
||
Once you join, check out the `#beginner-questions` and `nginx-users` channels :) | ||
|
||
### Documentation | ||
|
||
For a comprehensive list of all NGINX directives, check out <https://nginx.org>. | ||
|
||
For a comprehensive list of admin and deployment guides for all NGINX products, check out <https://docs.nginx.com>. | ||
|
||
### Mailing List | ||
|
||
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/>! | ||
|
||
## Contributing | ||
|
||
Please see the [contributing guide](https://github.com/nginxinc/docker-nginx/blob/master/CONTRIBUTING.md) for guidelines on how to best contribute to this project. | ||
|
||
## Commercial Support | ||
|
||
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! |