Skip to content

Commit 2039b02

Browse files
authored
Merge branch 'main' into issue-784
2 parents 714b454 + 469dd7e commit 2039b02

32 files changed

+222
-176
lines changed

.github/ISSUE_TEMPLATE/1-feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Feature request
33
about: Suggest an idea for this project
44
title: ""
5-
labels: ""
5+
labels: "enhancement"
66
assignees: ""
77
---
88

.github/ISSUE_TEMPLATE/2-bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Bug report
33
about: Create a report to help us improve
44
title: ""
5-
labels: ""
5+
labels: "bug"
66
assignees: ""
77
---
88

.github/pull_request_template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ Before merging a pull request, run through this checklist and mark each as compl
2626
- [ ] I have rebased my branch onto main
2727
- [ ] I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
2828
- [ ] 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)
3030
- [ ] If the change involves potentially sensitive changes[^1], I have assessed the possible impact
3131
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
3232
- [ ] 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)
3434

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.

CHANGELOG.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,36 @@
11
# Contributing guidelines
22

3-
The following is a set of guidelines for community contributions to this project.
4-
5-
We really appreciate your desire to contribute!
3+
The following are a set of guidelines for contributing to this project. We appreciate your desire to get involved!
64

75
If you are an F5 employee, see the following additional guidance on [Maintainers etiquette](/documentation/maintainers-etiquette.md).
86

97
## Table of contents
108

11-
- [Report a Bug](#report-a-bug)
12-
- [Suggest a Feature or Enhancement](#suggest-a-feature-or-enhancement)
13-
- [Open a Discussion](#open-a-discussion)
9+
- [Create an issue](#create-an-issue)
10+
- [Start a discussion](#start-a-discussion)
1411
- [Submit a pull request](#submit-a-pull-request)
15-
- [Issue Lifecycle](#issue-lifecycle)
12+
- [Issue lifecycle](#issue-lifecycle)
1613
- [Additional NGINX documentation](#additional-nginx-documentation)
1714
- [F5 Contributor License Agreement (CLA)](#f5-contributor-license-agreement)
1815

19-
## Report a bug
16+
## Create an issue
17+
18+
One way to contribute to the project is by [creating an issue](https://github.com/nginx/documentation/issues/new/choose).
19+
20+
The two most common are enhancements and bug reports. When using the issue templates, they will be automatically labelled.
21+
22+
- An enhancement is an improvement of some kind, such as a new document or additional detail for a product feature
23+
- A bug report draws attention to an issue in documentation, such as an incorrect command or outdated information
2024

21-
To report a bug, open an issue on GitHub with the label `bug` using the
22-
available bug report issue template. Before reporting a bug, make sure the
23-
issue has not already been reported.
25+
Before creating an issue, please check there is [no existing issue](https://github.com/nginx/documentation/issues?q=is%3Aissue) for the topic.
2426

25-
## Suggest a feature or enhancement
27+
We encourage discussions within issues, since they act as a source of contextual truth and are linked to pull requests.
2628

27-
To suggest a feature or enhancement, open an issue on GitHub with the label
28-
`feature` or `enhancement` using the available feature request issue template.
29-
Please ensure the feature or enhancement has not already been suggested.
29+
## Start a discussion
3030

31-
## Open a Discussion
31+
We encourage you to use [GitHub Discussions](https://github.com/nginx/documentation/discussions) for conversations with the community and maintainers.
3232

33-
If you want to start a conversation with the community and maintainers,
34-
we encourage you to use
35-
[GitHub Discussions](https://github.com/nginx/documentation/discussions).
33+
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/).
3634

3735
## Submit a pull request
3836

@@ -66,7 +64,6 @@ This repository does not include all of the source content for the NGINX documen
6664
- [NGINX Open Source](https://github.com/nginx/nginx) - source for [NGINX changelog](https://nginx.org/en/CHANGES)
6765
- [nginx.org](https://github.com/nginx/nginx.org) - source for https://nginx.org
6866
- [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
7067

7168
In those repositories, you can find documentation source code in the `docs` or `site` subdirectories.
7269

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,28 @@
44
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/nginxinc/template-repository/main/CODE_OF_CONDUCT.md)
55
![Commercial Support](https://badgen.net/badge/support/commercial/green?icon=awesome)
66

7-
<!-- These are the "repo [status badge](https://www.repostatus.org/)s" and the community support badges -->
8-
97
# NGINX documentation
108

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+
1113
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:
1214

1315
- [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
1516
- [Code of Conduct](/CODE_OF_CONDUCT.md) describes expectations in the NGINX open source community.
1617
- [License](/LICENSE) shows the license associated with work on this repository.
1718
- [Security](/SECURITY.md) describes the procedures we would like you to follow if you find a security issue.
1819
- [Support](/SUPPORT.md) lists how you can get support as a customer or a community member.
1920

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.
2622

2723
## License
2824

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

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

33-
3429
## Credits
3530

3631
- [The Good Docs Project](https://www.thegooddocsproject.dev/), whose templates we've adapted for our use.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
files:
3+
- content/nginx-one/secure-your-fleet/secure.md
4+
- content/nginx-one/getting-started.md
5+
---
6+
7+
Once you've logged in with your password, you should be able to see and select the NGINX One tile.
8+
9+
1. Select the **NGINX One** tile
10+
1. If needed, select **Enable Service**
11+
1. After the service has been enables, select **Visit Service** to load NGINX One Console
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
files:
3+
- content/nginx-one/secure-your-fleet/secure.md
4+
- content/nginx-one/getting-started.md
5+
---
6+
7+
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.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
files:
3+
- content/nginx-one/secure-your-fleet/secure.md
4+
- content/nginx-one/getting-started.md
5+
---
6+
7+
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.

content/nginx-one/_index.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,52 @@ nd-product: NGINX One
1313
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
1414
[//]: # "Use underscores for _italics_, and double asterisks for **bold**."
1515
[//]: # "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).
1717

1818
## Featured content
1919
[//]: # "You can add a maximum of three cards: any extra will not display."
2020
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
2121
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
2222
{{<card-layout>}}
2323
{{<card-section showAsCards="true" isFeaturedSection="true">}}
24-
{{<card title="Get started" titleUrl="nginx-one/getting-started/" isFeatured="true" icon="unplug">}}
25-
See benefits from the NGINX One Console
24+
{{<card title="Get started" titleUrl="/nginx-one/getting-started/" isFeatured="true" icon="unplug">}}
25+
Get up and running with NGINX One Console
2626
{{</card >}}
27-
{{<card title="Changelog" titleUrl="nginx-one/changelog/" icon="clock-alert">}}
27+
{{</card-section>}}
28+
{{</card-layout>}}
29+
30+
31+
{{<card-layout>}}
32+
{{<card-section showAsCards="true" >}}
33+
{{<card title="Connect more NGINX instances" titleUrl="/nginx-one/connect-instances/" >}}
34+
Work with data plane keys, containers, and proxy servers
35+
{{</card>}}
36+
{{<card title="Manage your NGINX instances" titleUrl="/nginx-one/nginx-configs/" >}}
37+
Manage one instance or groups of instances. Monitor certificates. Set up metrics.
38+
{{</card>}}
39+
{{<card title="Organize users with RBAC" titleUrl="/nginx-one/rbac/" >}}
40+
Assign responsibilities with role-based access control
41+
{{</card>}}
42+
{{<card title="Automate with the NGINX One API" titleUrl="/nginx-one/api/" >}}
43+
Manage your NGINX fleet over REST
44+
{{</card>}}
45+
{{</card-section>}}
46+
{{</card-layout>}}
47+
48+
### More information
49+
50+
{{<card-layout>}}
51+
{{<card-section showAsCards="true" >}}
52+
{{<card title="Glossary" titleUrl="/nginx-one/glossary/" >}}
2853
See latest updates: New features, improvements, and bug fixes
2954
{{</card>}}
30-
{{<card title="Add an NGINX instance" titleUrl="nginx-one/connect-instances/add-instance/" icon="copy-plus">}}
31-
Connect your instances to NGINX One
55+
{{<card title="Changelog" titleUrl="/nginx-one/changelog/" icon="clock-alert">}}
56+
See latest updates: New features, improvements, and bug fixes
3257
{{</card>}}
3358
{{</card-section>}}
3459
{{</card-layout>}}
3560

36-
## Other Components
61+
## NGINX One components
3762
[//]: # "You can add any extra content for the page here, such as additional cards, diagrams or text."
3863

3964
{{< card-layout >}}
@@ -66,4 +91,4 @@ The F5 NGINX One Console makes it easy to manage NGINX instances across location
6691
Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.
6792
{{</ card >}}
6893
{{</ card-section >}}
69-
{{</card-layout>}}
94+
{{</card-layout>}}

0 commit comments

Comments
 (0)