Skip to content

Commit fb44cb3

Browse files
mjangalessfg
andcommitted
✅ Ready to clone and code.
Co-authored-by: Alessandro Fael Garcia <alessfg@hotmail.com>
1 parent b63e9e9 commit fb44cb3

File tree

11 files changed

+82
-184
lines changed

11 files changed

+82
-184
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# the noted directories.
33
#
44
# 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 `@`)
5+
# open a pull request. Then add the appropriate group name (without the `@`)
66
# to the list of "Reviewers."
77
#
88
# Order is important; the last matching pattern takes precedence.

.github/workflows/rename_template.yml

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

.github/workflows/scripts/rename_project.sh

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

CHANGELOG.md

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

55
## 1.0.0 (Month Date, Year)
66

7-
Initial open source release of the documentation repository for enterprise NGINX products. The content was previously in a closed repository.
7+
Initial open source release of the documentation repository for enterprise NGINX products. This is a filtered mirror of an internal repository.

CONTRIBUTING.md

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,33 @@
1-
# Contributing Guidelines
1+
# Contributing guidelines
22

33
The following is a set of guidelines for contributing to this project.
44
We really appreciate your desire to contribute!
55

6-
## Table of Contents
6+
## Table of contents
77

8-
- [Ask a Question](#ask-a-question)
98
- [Report a Bug](#report-a-bug)
109
- [Suggest a Feature or Enhancement](#suggest-a-feature-or-enhancement)
1110
- [Open a Discussion](#open-a-discussion)
1211
- [Submit a Pull Request](#submit-a-pull-request)
12+
- Review our [Git style guide](#git-style-guide)
13+
- Review our Documentation [style guide](./templates/style-guide.md)
1314
- [Issue Lifecycle](#issue-lifecycle)
15+
- [Content edited elsewhere](#content-edited-elsewhere)
1416
- [F5 Contributor License Agreement (CLA)](#f5-contributor-license-agreement)
1517

16-
## Ask a Question
17-
18-
To ask a question, open an issue on GitHub with the label `question`.
19-
20-
## Report a Bug
18+
## Report a bug
2119

2220
To report a bug, open an issue on GitHub with the label `bug` using the
2321
available bug report issue template. Before reporting a bug, make sure the
2422
issue has not already been reported.
2523

26-
## Suggest a Feature or Enhancement
24+
## Suggest a feature or enhancement
2725

2826
To suggest a feature or enhancement, open an issue on GitHub with the label
2927
`feature` or `enhancement` using the available feature request issue template.
3028
Please ensure the feature or enhancement has not already been suggested.
3129

32-
## Open a Discussion
30+
## Open a discussion
3331

3432
If you want to start a conversation with the community and maintainers,
3533
we encourage you to use
@@ -44,32 +42,49 @@ To contribute to NGINX documentation, follow these steps:
4442
- Implement your changes in your branch
4543
- Submit a pull request (PR) when your changes are ready for review
4644

47-
## Contributing with Git
45+
Alternatively, you're welcome to suggest improvements to highlight problems with
46+
our documentation as described in our [support](./SUPPORT.md) page.
4847

49-
<!-- Separate doc pages, CONTRIBUTING_GIT.md and CONTRIBUTING_other.md.
50-
Need: issue to include "Edit this page" links, similar to what we already do for N Unit docs, https://unit.nginx.org/ -->
48+
### Git Style Guide
5149

52-
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).
53-
<!-- People who contribute via CloudCannon?
50+
- Keep a clean, concise and meaningful Git commit history on your branch, rebasing locally and squashing before you submit a PR
51+
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
52+
and summarized in the next few points:
5453

55-
We're working on alternative contribution methods, described in CONTRIBUTING_OTHER.md
56-
-->
54+
- In the subject line, use the present tense ("Add feature" not "Added feature")
55+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
56+
- Limit the subject line to 72 characters or less
57+
- Reference issues and pull requests liberally after the subject line
58+
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in
59+
your text editor to write a good message instead of `git commit -am`)
5760

58-
Alternatively, you're welcome to highlight problems with our documentation as
59-
described in our [support](./SUPPORT.md) page.
61+
### Docuemntation style guide
6062

61-
## Issue Lifecycle
63+
For detailed guidance, see our documentation [style guide](./templates/style-guide.md).
64+
65+
## Issue lifecycle
6266

6367
To ensure a balance between work carried out by the NGINX team while encouraging community involvement on this project, we use the following
6468
issue lifecycle:
6569

6670
- A new issue is created by a community member
6771
- An owner on the NGINX team is assigned to the issue; this owner shepherds the issue through the subsequent stages in the issue lifecycle
6872
- The owner assigns one or more [labels](https://github.com/nginxinc/oss-docs/issues/labels) to the issue
69-
- The owner, in collaboration with the wider team, determines what milestone to attach to an issue. They may be milestones correspond to product releases
73+
- The owner, in collaboration with the community member, determines what milestone to attach to an issue. They may be milestones correspond to product releases
74+
75+
## Content edited elsewhere
76+
77+
This repository does not include all documentation available at https://docs.nginx.com. Other relevant repositories include:
78+
79+
- [NGINX Open Source](https://github.com/nginx/nginx)
80+
- [NGINX Unit](https://github.com/nginx/unit)
81+
- [NGINX Ingress Controller](https://github.com/nginxinc/kubernetes-ingress/)
82+
- [NGINX Gateway Fabric](https://github.com/nginxinc/nginx-gateway-fabric)
83+
84+
You can find documentation source code in the `docs` or `site` subdirectories.
7085

7186
## F5 Contributor License Agreement
7287

73-
F5 requires all external contributors to agree to the terms of the [F5 CLA](./CLA/cla-markdown.md), before any of their changes can be incorporated into an F5 Open Source repository.
88+
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.
7489

75-
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.
90+
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.

CONTRIBUTING_GIT.md renamed to CONTRIBUTING_DOCS.md

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1+
# Contributing guidelines for experts
2+
13
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.
24

35
Once you add and/or edit our Markdown source files, you can build the content locally as described on this page.
46
Before you [Submit a Pull Request](#submit-a-pull-request), we recommend that you first:
57

68
- Set up our [Static site generator](#static-site-generator)
7-
- Review how to [Include images](#include-images)
8-
- Review our [Git style guide](#git-style-guide)
9+
- If you want to add images, review how to [Include images](#include-images)
910
- Learn how to [Build documentation locally](#build-documentation-locally)
1011

11-
## Static Site Generator
12+
## Static site generator
1213

1314
You will need to install Hugo to build and preview docs in your local development environment.
1415
Refer to the [Hugo installation instructions](https://gohugo.io/getting-started/installing/) for more information.
@@ -21,13 +22,14 @@ When you set up an image, this is the standard format:
2122

2223
{{< img src="path/to/images/file-name.png" alt="descriptive text for screenreaders" >}}
2324

25+
You'll find images in the [static](../static) subdirectory, in a directory assocaited with the documentation. For example, if you've set up the `file-name.png`
26+
image, you should copy that file to the `static/path/to/images` directory.
27+
2428
## Build documentation locally
2529

2630
To build and preview docs in your local development environment, you need to install Hugo.
2731
Refer to the [Hugo installation instructions](https://gohugo.io/getting-started/installing/) for more information.
2832

29-
**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.
30-
3133
## Submit a Pull Request
3234

3335
Follow this plan to contribute a change to NGINX source code:
@@ -37,35 +39,7 @@ Follow this plan to contribute a change to NGINX source code:
3739
- Implement your changes in this branch
3840
- Submit a pull request (PR) when your changes are tested and ready for review
3941

40-
### Git Style Guide
41-
42-
- Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before
43-
submitting a PR
44-
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
45-
and summarized in the next few points:
46-
47-
- In the subject line, use the present tense ("Add feature" not "Added feature")
48-
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
49-
- Limit the subject line to 72 characters or less
50-
- Reference issues and pull requests liberally after the subject line
51-
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in
52-
your text editor to write a good message instead of `git commit -am`)
53-
5442
### Add new docs
55-
<!--
56-
#### Generate a new doc file using Hugo
57-
58-
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:
59-
60-
`hugo new <SECTIONNAME>/<FILENAME>.<FORMAT>`
61-
62-
For example:
63-
64-
`hugo new getting-started/install.md`
65-
66-
The default template -- task -- should be used for most docs. To create docs using the other content templates, you can use the `--kind` flag:
67-
68-
`hugo new tutorials/deploy.md --kind tutorial` -->
6943

7044
Consistent with the [Diataxis](https://diataxis.fr) framework, our documentation includes the following content types:
7145

GET_STARTED.md

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

PREREQUISITES.md

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

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,10 @@
1010

1111
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:
1212

13-
- [Get started](/GET_STARTED.md) to help you get started with NGINX and our documentation.
1413
- [Contributing](/CONTRIBUTING.md) describes how you can contribute to our documentation.
15-
- [Contributing with Git](/CONTRIBUTING_GIT.md) describes how you can contribute (and check your work) with Git and command line tools.
14+
- [Contributing guidelines for experts](/CONTRIBUTING_DOCS.md) describes how you can contribute (and check your work) with Hugo, our static site generator
1615
- [Code of Conduct](/CODE_OF_CONDUCT.md) describes expectations in the NGINX open source community.
17-
- [Creative Commons License](/LICENSE) shows the Creative Commons license associated with work on this repository.
18-
- [Prerequisties](/PREREQUISITES.md) lists the hardware and software that you need to get started with NGINX.
16+
- [License](/LICENSE) shows the license associated with work on this repository.
1917
- [Security](/SECURITY.md) describes the procedures we would like you to follow if you find a security issue.
2018
- [Support](/SUPPORT.md) lists how you can get support as a customer or a community member.
2119

SUPPORT.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,10 @@ Don't know how something in this project works? Curious if this project can achi
88

99
Alternatively, open a [discussion](https://github.com/nginxinc/oss-docs/discussions) in this repository.
1010

11-
If you know the answer, open a pull request!
12-
<!-- Add a link to GH issues, Discourse, F5 Dev Central, Qualtrix?-->
13-
1411
## NGINX Specific Questions and/or Issues
1512

1613
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
1714

18-
<!-- ### Discourse
19-
20-
We have a community [Slack](https://nginxcommunity.slack.com/)!
21-
22-
If you are not a member, click [here](https://community.nginx.org/joinslack) to sign up. (Let us know if the link does not seem to be working at <nginx-oss-community@f5.com>!)
23-
24-
Once you join, check out the `#beginner-questions` and `nginx-users` channels :) -->
25-
2615
### Mailing List
2716

2817
Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found at <https://mailman.nginx.org/mailman3/lists/>!

0 commit comments

Comments
 (0)