Skip to content

Commit

Permalink
Apply suggestions from @ADubhlaoich
Browse files Browse the repository at this point in the history
Co-authored-by: Alan Dooley <[email protected]>
  • Loading branch information
mjang and ADubhlaoich committed Aug 30, 2024
1 parent 36c5e1a commit 0b619cd
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 22 deletions.
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@

## 1.0.0 (Month Date, Year)

Initial open source release of the documentation repository for premium NGINX products. The content was previously in a closed repository.
<!-- Is "premium" the right word? -->
Initial open source release of the documentation repository for enterprise NGINX products. The content was previously in a closed repository.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ If you have not yet agreed to the F5 CLA terms and submit a PR to this repositor

## Options to get started

<!-- Separate doc pages, CONTRIBUTING_GIT.md and CONTRIBUTING_other.md. If we use Cloud Cannon, maybe we can link to their docs. For now, I'll. -->
<!-- Separate doc pages, CONTRIBUTING_GIT.md and CONTRIBUTING_other.md.
Need: issue to include "Edit this page" links, similar to what we already do for N Unit docs, https://unit.nginx.org/ -->

At this time, we support contributions using Git. We expect this audience to also know how to build documentation using the command line. If you're in this group, start with how you can [contribute with Git](./CONTRIBUTING_GIT.md).
<!-- People who contribute via CloudCannon?
Expand Down
8 changes: 3 additions & 5 deletions GET_STARTED.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
## Get Started

You can find F5 NGINX docs at https://docs.nginx.com. You can use these docs to install and configure both open source and F5 NGINX products.
You can find F5 NGINX documentation at https://docs.nginx.com. These documents describe how to install and configure both open source and commercial projects.

This repository is focused on NGINX documentation. Each NGNIX product and module includes documentation on how you can install, and yes, get started with the product.

Many of our products are open source. If you want to try one of our other products, you can:
If you want to try one of our commercial products, you can:

- Get a [trial license](https://www.f5.com/trials)
- Use the procedures in our [NGINX Solutions](https://docs.nginx.com/solutions/) site to download, install, and activate the product of your choice.

The same procedures apply if you have a paid subscription.
The same procedures apply if whether you have a paid or a trial subscription.
<!-- Ideal world, I'd include links to "Get started" or "Install" procedures for each product/module. -->
24 changes: 12 additions & 12 deletions PREREQUISITES.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
## Prerequisites

In general, you can install F5 NGINX on any modern major Linux/UNIX distribution, locally or in the "cloud." However, support is limited to the distributions shown in the prerequisites for each product, as linked from this page.
In general, you can install F5 NGINX on any modern major Linux/UNIX distribution, on-premises or in the "cloud." However, support is limited to the distributions shown in the prerequisites for each product, as linked from this page.

In some cases, F5 NGINX products include technical specifications.
Most NGINX projects include technical specifications, as well as compatibility tables for integrating various parts of NGINX software.

In many cases, you can also install NGINX in Docker containers, or with the help of Kubernetes.

This page includes links prerequisites or technical specifications for each product:
This page includes links prerequisites or technical specifications for each project:

### Open source products
### Open source projects

- [NGINX Open Source](https://nginx.org/en/docs/install.html)
- [NGINX Unit](https://unit.nginx.org/installation/#prerequisites)
- [NGINX Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/)
- [NGINX Gateway Fabric](https://github.com/nginxinc/nginx-gateway-fabric#technical-specifications)
- [NGINX Amplify](https://docs.nginx.com/amplify/overview/overview-main-components/)<!-- not a standalone product, so the other products are prereqs -->
- [NGINX Amplify](https://docs.nginx.com/amplify/overview/overview-main-components/)

### Subscription products
### Commercial products

- [F5 NGINX Plus](https\://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/\#prerequisites)
- [F5 NGINX Management Suite](https://docs.nginx.com/nginx-management-suite/tech-specs/)
- [F5 NGINX App Protect WAF](https://docs.nginx.com/nginx-app-protect-waf/v4/admin-guide/install/#prerequisites))
- [F5 NGINX App Protect DoS](https://docs.nginx.com/nginx-app-protect-dos/deployment-guide/learn-about-deployment/#prerequisites)
- [F5 NGINX Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/)
- [F5 NGINXaaS for Azure](https://docs.nginx.com/nginxaas/azure/getting-started/prerequisites/)
- [NGINX Plus](https\://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/\#prerequisites)
- [NGINX Management Suite](https://docs.nginx.com/nginx-management-suite/tech-specs/)
- [NGINXaaS for Azure](https://docs.nginx.com/nginxaas/azure/getting-started/prerequisites/)
- [NGINX App Protect WAF](https://docs.nginx.com/nginx-app-protect-waf/v4/admin-guide/install/#prerequisites))
- [NGINX App Protect DoS](https://docs.nginx.com/nginx-app-protect-dos/deployment-guide/learn-about-deployment/#prerequisites)
<!--
IMO, there's no reason to include the legacy products: Controller, Service Mesh, ModSecurity WAF -->
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This repository contains user documentation for NGINX's products, as well as the
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.

## Publishing Environments
## Publishing environments

When you submit a Pull request, our setup automatically builds the documentation with your proposed changes at the following URL:

Expand Down
2 changes: 1 addition & 1 deletion SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ For a comprehensive list of administration and deployment guides for all NGINX p

Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.

## Commercial Support
## Commercial support

Commercial support for these projects may be available. Please get in touch with [NGINX sales](https://www.nginx.com/contact-sales/) or check your contract details for more information.

Expand Down

0 comments on commit 0b619cd

Please sign in to comment.