Skip to content

Commit f7b052d

Browse files
committed
docs: Community READMEs (and more), iteration 1
- Apply suggestions from @ADubhlaoich, @travismartin, @yar - Co-authored-by: Alan Dooley <github@adubhlaoi.ch> - Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com>
1 parent 205fbeb commit f7b052d

32 files changed

+3294
-294
lines changed

.github/CODEOWNERS

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1-
# Main global owner #
2-
#####################
3-
*
1+
# Each of these groups of CODEOWNERS have approval and merge authority over
2+
# the noted directories.
3+
#
4+
# If you want to add, modify, or delete files in any of these directories,
5+
# open a pull request. Then add the approrpriate group name (without the `@`)
6+
# to the list of "Reviewers."
7+
#
8+
# Order is important; the last matching pattern takes precedence.
9+
# For example, when someone opens a pull request that only modifies files
10+
# in the content/nginx-one directory, you should assign @nginxinc/one-docs-approvers
11+
# as a reviewer.
12+
#
13+
# Lines starting with '#' are comments.
14+
# Each line is a file pattern followed by one or more owners.
15+
16+
# DocOps
17+
* @nginxinc/nginx-docs
18+
# NGINX Plus
19+
content/nginx/* @nginxinc/plus-docs-approvers
20+
# NGINX Agent
21+
content/nginx/nms/agent/* @nginxinc/agent-docs-approvers
22+
# NGINX One
23+
content/nginx-one/* @nginxinc/one-docs-approvers
24+
# NGINX Instance Manager
25+
content/nms/nim/* @nginxinc/nim-docs-approvers
26+
content/nim/* @nginxinc/nim-docs-approvers
27+
# NGINX App Protect WAF
28+
content/nap-waf/* @nginxinc/nap-docs-approvers
29+
data/nap-waf/* @nginxinc/nap-docs-approvers
30+
# NGINX App Protect DoS
31+
content/nap-dos/* @nginxinc/dos-docs-approvers

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Changelog
22

3+
<!-- While we have a changelog for current docs at https://github.com/nginxinc/docs/blob/main/CHANGELOG.md, I'm not convinced -->
4+
35
## 1.0.0 (Month Date, Year)
46

5-
Initial release of the NGINX template repository.
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: 14 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,23 @@
1-
# Contributing Guidelines
1+
# Contributing guidelines
22

3-
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering contributing!
3+
The following is a set of guidelines for contributing to this project. We really appreciate your desire to contribute!
44

5-
#### Table Of Contents
6-
7-
[Getting Started](#getting-started)
8-
9-
[Contributing](#contributing)
10-
11-
[Code Guidelines](#code-guidelines)
12-
13-
[Code of Conduct](/CODE_OF_CONDUCT.md)
14-
15-
## Getting Started
16-
17-
Follow the instructions on the README's [Getting Started](/README.md#Getting-Started) section to get this project up and running.
18-
19-
<!-- ### Project Structure (OPTIONAL) -->
20-
21-
## Contributing
22-
23-
### Report a Bug
24-
25-
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](/SECURITY.md).**
26-
27-
### Suggest a Feature or Enhancement
28-
29-
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.
30-
31-
### Open a Pull Request (PR)
32-
33-
- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are **tested** and ready for review.
34-
- Fill in the [PR template](/.github/pull_request_template.md).
35-
36-
**Note:** If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.
37-
38-
#### F5 Contributor License Agreement (CLA)
5+
## F5 Contributor License Agreement (CLA)
396

407
F5 requires all external contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) before any of their changes can be incorporated into an F5 Open Source repository.
418

42-
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.
9+
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future Pull or Merge Requests.
10+
11+
## Options to get started
4312

44-
## Code Guidelines
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/ -->
4515

46-
<!-- ### Go/Python/Bash/etc... Guidelines (OPTIONAL) -->
16+
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).
17+
<!-- People who contribute via CloudCannon?
4718
48-
### Git Guidelines
19+
We're working on alternative contribution methods, described in CONTRIBUTING_OTHER.md
20+
-->
4921

50-
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
51-
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated.
52-
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarized in the next few points:
53-
- In the subject line, use the present tense ("Add feature" not "Added feature").
54-
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
55-
- Limit the subject line to 72 characters or less.
56-
- Reference issues and pull requests liberally after the subject line.
57-
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).
22+
Alternatively, you're welcome to highight problems with our documentation as
23+
described in our [support](./SUPPORT.md) page.

CONTRIBUTING_GIT.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
If you want to contribute, know Git, and can work from the command line, this page can help you. As noted in the [README](./README.md), we create source content for our documentation in Markdown.
2+
3+
Once you add and/or edit our Markdown source files, you can build the content locally as described on this page.
4+
5+
## Static Site Generator (Hugo)
6+
7+
We build our documentation with the [Hugo](https://gohugo.io/) static site generator.
8+
9+
## Images
10+
11+
When you set up an image, this is the standard format:
12+
13+
{{< img src="path/to/images/file-name.png" alt="descriptive text for screenreaders" >}}
14+
15+
## Build documentation locally
16+
17+
To build and preview docs in your local development environment, you need to install Hugo.
18+
Refer to the [Hugo installation instructions](https://gohugo.io/getting-started/installing/) for more information.
19+
20+
**NOTE**: We are currently running [Hugo v0.115.3](https://github.com/gohugoio/hugo/releases/tag/v0.115.3) in production. If you run a different version of Hugo (older or newer), you might see unexpected errors.
21+
22+
### Local docs development
23+
24+
To build the docs locally, run the desired `make` command from the docs directory:
25+
26+
```text
27+
make docs - runs a local Hugo server so you can view docs in your browser while you work
28+
make hugo-mod - cleans the Hugo module cache and fetches the latest version of the theme module
29+
make docs-drafts - runs the local Hugo server and includes all docs marked with `draft: true`
30+
make clean - removes the local `public` directory, which is the default output path used by Hugo
31+
```
32+
33+
### Add new docs
34+
<!--
35+
#### Generate a new doc file using Hugo
36+
37+
To create a new doc file that contains all of the pre-configured Hugo front-matter and the docs task template, run the following command:
38+
39+
`hugo new <SECTIONNAME>/<FILENAME>.<FORMAT>`
40+
41+
For example:
42+
43+
`hugo new getting-started/install.md`
44+
45+
The default template -- task -- should be used for most docs. To create docs using the other content templates, you can use the `--kind` flag:
46+
47+
`hugo new tutorials/deploy.md --kind tutorial` -->
48+
49+
Consistent with the [Diataxis](https://diataxis.fr) framework, our documentation includes the following content types:
50+
51+
- concept: Helps a customer learn about a specific feature or feature set.
52+
- tutorial: Walks a customer through an example use case scenario; results in a functional PoC environment.
53+
- reference: Describes an API, command line tool, config options, etc.; should be generated automatically from source code.
54+
- openapi: Contains front-matter and shortcode for rendering an openapi.yaml spec.
55+
56+
### How to format docs
57+
58+
#### How to format internal links
59+
60+
Format links as [Hugo `refs`](https://gohugo.io/content-management/cross-references/).
61+
62+
- File extensions are optional.

GET_STARTED.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Get Started
2+
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.
4+
5+
If you want to try one of our commercial products, you can:
6+
7+
- Get a [trial license](https://www.f5.com/trials)
8+
- Use the procedures in our [NGINX Solutions](https://docs.nginx.com/solutions/) site to download, install, and activate the product of your choice.
9+
10+
The same procedures apply whether you have a paid or a trial subscription.
11+
<!-- Ideal world, I'd include links to "Get started" or "Install" procedures for each product/module. -->

0 commit comments

Comments
 (0)