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
To ask a question, open an issue on GitHub with the label `question`.
19
-
20
-
## Report a Bug
18
+
## Report a bug
21
19
22
20
To report a bug, open an issue on GitHub with the label `bug` using the
23
21
available bug report issue template. Before reporting a bug, make sure the
24
22
issue has not already been reported.
25
23
26
-
## Suggest a Feature or Enhancement
24
+
## Suggest a feature or enhancement
27
25
28
26
To suggest a feature or enhancement, open an issue on GitHub with the label
29
27
`feature` or `enhancement` using the available feature request issue template.
30
28
Please ensure the feature or enhancement has not already been suggested.
31
29
32
-
## Open a Discussion
30
+
## Open a discussion
33
31
34
32
If you want to start a conversation with the community and maintainers,
35
33
we encourage you to use
@@ -44,32 +42,49 @@ To contribute to NGINX documentation, follow these steps:
44
42
- Implement your changes in your branch
45
43
- Submit a pull request (PR) when your changes are ready for review
46
44
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.
48
47
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
51
49
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:
54
53
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`)
57
60
58
-
Alternatively, you're welcome to highlight problems with our documentation as
59
-
described in our [support](./SUPPORT.md) page.
61
+
### Docuemntation style guide
60
62
61
-
## Issue Lifecycle
63
+
For detailed guidance, see our documentation [style guide](./templates/style-guide.md).
64
+
65
+
## Issue lifecycle
62
66
63
67
To ensure a balance between work carried out by the NGINX team while encouraging community involvement on this project, we use the following
64
68
issue lifecycle:
65
69
66
70
- A new issue is created by a community member
67
71
- An owner on the NGINX team is assigned to the issue; this owner shepherds the issue through the subsequent stages in the issue lifecycle
68
72
- 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)
You can find documentation source code in the `docs` or `site` subdirectories.
70
85
71
86
## F5 Contributor License Agreement
72
87
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.
74
89
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.
Copy file name to clipboardExpand all lines: CONTRIBUTING_DOCS.md
+7-33Lines changed: 7 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,15 @@
1
+
# Contributing guidelines for experts
2
+
1
3
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
4
3
5
Once you add and/or edit our Markdown source files, you can build the content locally as described on this page.
4
6
Before you [Submit a Pull Request](#submit-a-pull-request), we recommend that you first:
5
7
6
8
- 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)
9
10
- Learn how to [Build documentation locally](#build-documentation-locally)
10
11
11
-
## Static Site Generator
12
+
## Static site generator
12
13
13
14
You will need to install Hugo to build and preview docs in your local development environment.
14
15
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:
21
22
22
23
{{< img src="path/to/images/file-name.png" alt="descriptive text for screenreaders" >}}
23
24
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
+
24
28
## Build documentation locally
25
29
26
30
To build and preview docs in your local development environment, you need to install Hugo.
27
31
Refer to the [Hugo installation instructions](https://gohugo.io/getting-started/installing/) for more information.
28
32
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
-
31
33
## Submit a Pull Request
32
34
33
35
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:
37
39
- Implement your changes in this branch
38
40
- Submit a pull request (PR) when your changes are tested and ready for review
39
41
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
-
54
42
### 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` -->
69
43
70
44
Consistent with the [Diataxis](https://diataxis.fr) framework, our documentation includes the following content types:
Copy file name to clipboardExpand all lines: README.md
+2-4Lines changed: 2 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,10 @@
10
10
11
11
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:
12
12
13
-
-[Get started](/GET_STARTED.md) to help you get started with NGINX and our documentation.
14
13
-[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
16
15
-[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.
19
17
-[Security](/SECURITY.md) describes the procedures we would like you to follow if you find a security issue.
20
18
-[Support](/SUPPORT.md) lists how you can get support as a customer or a community member.
Copy file name to clipboardExpand all lines: SUPPORT.md
-11Lines changed: 0 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -8,21 +8,10 @@ Don't know how something in this project works? Curious if this project can achi
8
8
9
9
Alternatively, open a [discussion](https://github.com/nginxinc/oss-docs/discussions) in this repository.
10
10
11
-
If you know the answer, open a pull request!
12
-
<!-- Add a link to GH issues, Discourse, F5 Dev Central, Qualtrix?-->
13
-
14
11
## NGINX Specific Questions and/or Issues
15
12
16
13
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
17
14
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
-
26
15
### Mailing List
27
16
28
17
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