Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Travis Martin <[email protected]>
  • Loading branch information
mjang and travisamartin authored Sep 3, 2024
1 parent 0b619cd commit 31988b0
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
# open a pull request. Then add the approrpriate group name (without the `@`)
# to the list of "Reviewers."
#
# Order is important; the last matching pattern takes the most
# precedence. When someone opens a pull request that only
# modifies JS files, only @js-owner and not the global
# owner(s) will be requested for a review.
# *.js @js-owner #This is an inline comment.
# Order is important; the last matching pattern takes precedence.
# For example, when someone opens a pull request that only modifies files
# in the content/nginx-one directory, you should assign @nginxinc/one-docs-approvers
# as a reviewer.
#
# Lines starting with '#' are comments.
# Each line is a file pattern followed by one or more owners.

Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING_GIT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Once you add and/or edit our Markdown source files, you can build the content lo

We build our documentation with the [Hugo](https://gohugo.io/) static site generator.

## Images and downloads
## Images

When you set up an image, this is the standard format:

Expand All @@ -24,9 +24,9 @@ Refer to the [Hugo installation instructions](https://gohugo.io/getting-started/
To build the docs locally, run the desired `make` command from the docs directory:

```text
make docs - runs a local hugo server so you can view docs in your browser while you work
make docs - runs a local Hugo server so you can view docs in your browser while you work
make hugo-mod - cleans the Hugo module cache and fetches the latest version of the theme module
make docs-drafts - runs the local hugo server and includes all docs marked with `draft: true`
make docs-drafts - runs the local Hugo server and includes all docs marked with `draft: true`
make clean - removes the local `public` directory, which is the default output path used by Hugo
```

Expand Down
2 changes: 1 addition & 1 deletion GET_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ 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 whether you have a paid or a trial subscription.
The same procedures apply 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. -->
2 changes: 1 addition & 1 deletion PREREQUISITES.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This page includes links prerequisites or technical specifications for each proj
- [NGINX Gateway Fabric](https://github.com/nginxinc/nginx-gateway-fabric#technical-specifications)
- [NGINX Amplify](https://docs.nginx.com/amplify/overview/overview-main-components/)

### Commercial products
### Enterprise products

- [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/)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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

# NGINX Documentation
# NGINX documentation

If you want to contribute to F5 NGINX documentation, you've come to the right place. We've organized a series of README-type files to help you get started:

Expand Down
2 changes: 1 addition & 1 deletion SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to b

## 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.
Commercial support for these projects may be available. Please get in touch with [F5 sales](https://www.f5.com/products/get-f5) or check your contract details for more information.

## Community Support

Expand Down

0 comments on commit 31988b0

Please sign in to comment.