Skip to content

Auto-generated PR: Auto-generated PR #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Auto-generated PR: Auto-generated PR #721

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 1 addition & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1 @@
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/template-repository/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginxinc/template-repository)
[![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)
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/template-repository/blob/main/SUPPORT.md)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/nginxinc/template-repository/main/CODE_OF_CONDUCT.md)
![Commercial Support](https://badgen.net/badge/support/commercial/green?icon=awesome)

<!-- These are the "repo [status badge](https://www.repostatus.org/)s" and the community support badges -->

# NGINX documentation

If you want to contribute to [F5 NGINX documentation](https://docs.nginx.com), you've come to the right place. We've organized a series of README-type files to help you get started:

- [Contributing](/CONTRIBUTING.md) describes how you can contribute to our documentation.
- [Contributing guidelines for experts](/CONTRIBUTING_DOCS.md) describes how you can contribute (and check your work) with Hugo, our static site generator
- [Code of Conduct](/CODE_OF_CONDUCT.md) describes expectations in the NGINX open source community.
- [License](/LICENSE) shows the license associated with work on this repository.
- [Security](/SECURITY.md) describes the procedures we would like you to follow if you find a security issue.
- [Support](/SUPPORT.md) lists how you can get support as a customer or a community member.

## Explanation

This repository contains user documentation for NGINX's products, as well as the requirements for linting, building, and publishing the documentation.

Our documentation is written in Markdown, specifically the [Goldmark](https://github.com/yuin/goldmark) Markdown parser.
We build our docs using [Hugo](https://gohugo.io) and host them in custom URLs on Azure.

## License

[BSD 2-Clause "Simplified" License](/LICENSE)

&copy; [F5, Inc.](https://www.f5.com/) 2025


## Credits

- [The Good Docs Project](https://www.thegooddocsproject.dev/), whose templates we've adapted for our use.
test_pat!