Skip to content

Commit 0b619cd

Browse files
mjangADubhlaoich
andcommitted
Apply suggestions from @ADubhlaoich
Co-authored-by: Alan Dooley <github@adubhlaoi.ch>
1 parent 36c5e1a commit 0b619cd

File tree

6 files changed

+20
-22
lines changed

6 files changed

+20
-22
lines changed

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@
44

55
## 1.0.0 (Month Date, Year)
66

7-
Initial open source release of the documentation repository for premium NGINX products. The content was previously in a closed repository.
8-
<!-- Is "premium" the right word? -->
7+
Initial open source release of the documentation repository for enterprise NGINX products. The content was previously in a closed repository.

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ If you have not yet agreed to the F5 CLA terms and submit a PR to this repositor
1010

1111
## Options to get started
1212

13-
<!-- 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. -->
13+
<!-- Separate doc pages, CONTRIBUTING_GIT.md and CONTRIBUTING_other.md.
14+
Need: issue to include "Edit this page" links, similar to what we already do for N Unit docs, https://unit.nginx.org/ -->
1415

1516
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).
1617
<!-- People who contribute via CloudCannon?

GET_STARTED.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
## Get Started
22

3-
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.
3+
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.
44

5-
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.
6-
7-
Many of our products are open source. If you want to try one of our other products, you can:
5+
If you want to try one of our commercial products, you can:
86

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

12-
The same procedures apply if you have a paid subscription.
10+
The same procedures apply if whether you have a paid or a trial subscription.
1311
<!-- Ideal world, I'd include links to "Get started" or "Install" procedures for each product/module. -->

PREREQUISITES.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
## Prerequisites
22

3-
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.
3+
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.
44

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

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

9-
This page includes links prerequisites or technical specifications for each product:
9+
This page includes links prerequisites or technical specifications for each project:
1010

11-
### Open source products
11+
### Open source projects
1212

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

18-
### Subscription products
19+
### Commercial products
1920

20-
- [F5 NGINX Plus](https\://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/\#prerequisites)
21-
- [F5 NGINX Management Suite](https://docs.nginx.com/nginx-management-suite/tech-specs/)
22-
- [F5 NGINX App Protect WAF](https://docs.nginx.com/nginx-app-protect-waf/v4/admin-guide/install/#prerequisites))
23-
- [F5 NGINX App Protect DoS](https://docs.nginx.com/nginx-app-protect-dos/deployment-guide/learn-about-deployment/#prerequisites)
24-
- [F5 NGINX Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/technical-specifications/)
25-
- [F5 NGINXaaS for Azure](https://docs.nginx.com/nginxaas/azure/getting-started/prerequisites/)
21+
- [NGINX Plus](https\://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/\#prerequisites)
22+
- [NGINX Management Suite](https://docs.nginx.com/nginx-management-suite/tech-specs/)
23+
- [NGINXaaS for Azure](https://docs.nginx.com/nginxaas/azure/getting-started/prerequisites/)
24+
- [NGINX App Protect WAF](https://docs.nginx.com/nginx-app-protect-waf/v4/admin-guide/install/#prerequisites))
25+
- [NGINX App Protect DoS](https://docs.nginx.com/nginx-app-protect-dos/deployment-guide/learn-about-deployment/#prerequisites)
2626
<!--
2727
IMO, there's no reason to include the legacy products: Controller, Service Mesh, ModSecurity WAF -->

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This repository contains user documentation for NGINX's products, as well as the
2525
Our documentation is written in Markdown, specifically the [Goldmark](https://github.com/yuin/goldmark) Markdown parser.
2626
We build our docs using [Hugo](https://gohugo.io) and host them in custom URLs on Azure.
2727

28-
## Publishing Environments
28+
## Publishing environments
2929

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

SUPPORT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For a comprehensive list of administration and deployment guides for all NGINX p
3535

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

38-
## Commercial Support
38+
## Commercial support
3939

4040
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.
4141

0 commit comments

Comments
 (0)