You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,10 +26,10 @@ Before merging a pull request, run through this checklist and mark each as compl
26
26
-[ ] I have rebased my branch onto main
27
27
-[ ] I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
28
28
-[ ] I have ensured that the commit messages adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
29
-
-[ ] I have ensured that documentation content adheres to [the style guide](https://github.com/nginx/documentation/blob/main/templates/style-guide.md)
29
+
-[ ] I have ensured that documentation content adheres to [the style guide](/documentation/style-guide.md)
30
30
-[ ] If the change involves potentially sensitive changes[^1], I have assessed the possible impact
31
31
-[ ] If applicable, I have added tests that prove my fix is effective or that my feature works
32
32
-[ ] I have ensured that existing tests pass after adding my changes
33
-
-[ ] If applicable, I have updated [`README.md`](https://github.com/nginx/documentation/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/nginx/documentation/blob/main/CHANGELOG.md)
33
+
-[ ] If applicable, I have updated [`README.md`](/README.md)
34
34
35
-
[^1]: Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to [our style guide](https://github.com/nginx/documentation/blob/main/templates/style-guide.md) for guidance about placeholder content.
35
+
[^1]: Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to [our style guide](/documentation/style-guide.md) for guidance about placeholder content.
If you'd like to discuss something NGINX-related that doesn't involve documentation, you should go to the [NGINX Community Forum](https://community.nginx.org/).
36
34
37
35
## Submit a pull request
38
36
@@ -66,7 +64,6 @@ This repository does not include all of the source content for the NGINX documen
66
64
-[NGINX Open Source](https://github.com/nginx/nginx) - source for [NGINX changelog](https://nginx.org/en/CHANGES)
67
65
-[nginx.org](https://github.com/nginx/nginx.org) - source for https://nginx.org
68
66
-[NGINX Unit](https://github.com/nginx/unit) - source for https://unit.nginx.org
69
-
-[NGINX Ingress Controller](https://github.com/nginxinc/kubernetes-ingress/) - source for https://docs.nginx.com/nginx-ingress-controller
70
67
71
68
In those repositories, you can find documentation source code in the `docs` or `site` subdirectories.
<!-- These are the "repo [status badge](https://www.repostatus.org/)s" and the community support badges -->
8
-
9
7
# NGINX documentation
10
8
9
+
This repository contains the user documentation for NGINX's products, as well as the requirements to build and publish the documentation website.
10
+
11
+
Documentation is written in [Markdown](https://daringfireball.net/projects/markdown/basics), then transformed into HTML using the [Hugo](https://gohugo.io/) static site generator.
12
+
11
13
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:
12
14
13
15
-[Contributing](/CONTRIBUTING.md) describes how you can contribute to our documentation.
14
-
-[Contributing guidelines for experts](/CONTRIBUTING_DOCS.md) describes how you can contribute (and check your work) with Hugo, our static site generator
15
16
-[Code of Conduct](/CODE_OF_CONDUCT.md) describes expectations in the NGINX open source community.
16
17
-[License](/LICENSE) shows the license associated with work on this repository.
17
18
-[Security](/SECURITY.md) describes the procedures we would like you to follow if you find a security issue.
18
19
-[Support](/SUPPORT.md) lists how you can get support as a customer or a community member.
19
20
20
-
## Explanation
21
-
22
-
This repository contains user documentation for NGINX's products, as well as the requirements for linting, building, and publishing the documentation.
23
-
24
-
Our documentation is written in Markdown, specifically the [Goldmark](https://github.com/yuin/goldmark) Markdown parser.
25
-
We build our docs using [Hugo](https://gohugo.io) and host them in custom URLs on Azure.
21
+
You may also find the [documentation folder](/documentation/) for the repository interesting: it's where we store our process information.
Confirm an F5 Distributed Cloud tenant has been provisioned for you. Log in to MyF5 and review your subscriptions. You should see within one of your subscriptions "Distributed Cloud". This could be in either an NGINX subscription or a Distributed Cloud. If the above does not appear in any of your subscriptions, reach out to either your F5 Account Team or Customer Success Manager.
8
+
9
+
With access, you or someone in your organization should have an email from [email protected] asking you to update your password when the tenant was created. The account name referenced in the E-Mail in bold is the tenant name.
10
+
11
+
Navigate to https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io/ to access F5 Distributed Cloud. If you have never logged in, select the **Forgot Password?** option in the log in screen. Alternatively, if someone within your organization has access, ask them to add you as a user within your tenant with a role providing permissions for NGINX One.
If you need to set up an instance of NGINX, you can do so in one of the following ways:
8
+
9
+
- Install [NGINX Open Source or NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/" >}}). You can use the linked guide to install NGINX in a Linux environment, in a VM or on bare-metal hardware.
10
+
-[Deploy NGINX and NGINX Plus with Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md" >}}) with NGINX and the NGINX Agent installed.
Copy file name to clipboardExpand all lines: content/nginx-one/_index.md
+33-8Lines changed: 33 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,27 +13,52 @@ nd-product: NGINX One
13
13
[//]: #"These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
14
14
[//]: #"Use underscores for _italics_, and double asterisks for **bold**."
15
15
[//]: #"Backticks are for `monospace`, used sparingly and reserved mostly for executable names - they can cause formatting problems. Avoid them in tables: use italics instead."
16
-
The F5 NGINX One Console makes it easy to manage NGINX instances across locations and environments. The console lets you monitor and control your NGINX fleet from one place—you can check configurations, track performance metrics, identify security vulnerabilities, manage SSL certificates, and more.
16
+
F5 NGINX One Console makes it easy to manage NGINX instances across locations and environments. The console lets you monitor and control your NGINX fleet from one place—you can check configurations, track performance metrics, identify security vulnerabilities, manage SSL certificates, and more. NGINX One Console is part of NGINX One, which includes [NGINX One components](#nginx-one-components).
17
17
18
18
## Featured content
19
19
[//]: #"You can add a maximum of three cards: any extra will not display."
20
20
[//]: #"One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
21
21
[//]: #"Some examples of content could be the latest release note, the most common install path, and a popular new feature."
0 commit comments