Skip to content

Commit b9ef2ff

Browse files
committed
fix: Clarify README-type files from the community PoV
* Update F5 instructions * Include instructions for linking to a GH issue in the PR template
1 parent bd7100f commit b9ef2ff

File tree

4 files changed

+8
-15
lines changed

4 files changed

+8
-15
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Testing: Describe any testing that you did.
1313
Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
1414
specific feedback, add them here.
1515

16+
If this PR addresses an [issue](https://github.com/nginx/documentation/issues) on GitHub, ensure that you link to it here:
17+
1618
Closes #ISSUE
1719

1820
### Checklist

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The following is a set of guidelines for community contributions to this
44
project. We really appreciate your desire to contribute!
55

6-
If you are an F5/NGINX employee, see the following guidance [For F5/NGINX Employees](./F5-NGINX-team-notes.md).
6+
If you are an F5/NGINX employee, see the following additional guidance [For F5/NGINX Employees](./F5-NGINX-team-notes.md).
77

88
## Table of contents
99

@@ -34,7 +34,7 @@ Please ensure the feature or enhancement has not already been suggested.
3434

3535
If you want to start a conversation with the community and maintainers,
3636
we encourage you to use
37-
[GitHub Discussions](https://github.com/nginxinc/oss-docs/discussions).
37+
[GitHub Discussions](https://github.com/nginx/documentation/discussions).
3838

3939
## Submit a Pull Request
4040

F5-NGINX-team-notes.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,9 @@ public repository. However, if you are working with:
66
- Security content, including personally identifying information (PII).
77
- Content / features that are not yet ready to be announced.
88

9-
Make changes to the private `docs` repository. When you create a branch, start it with:
10-
`internal/`.
9+
Before new content is published at https://docs.nginx.com, it must be written to this `documentation` repository. After you get approvals in the internal `docs` repository, you'll need to create a _second_ pull request in this open `documentation` repository.
1110

12-
- The public `documentation` repository will reject branches that start with `internal/`.
13-
- The private `docs` repository will accept branches _only_ if it includes `internal/`.
14-
15-
Before new content is published, it must be written to the open `documentation` repository. After you get approvals in the internal `docs` repository, you'll need to create a _second_ pull request in the open `documentation` repository.
16-
17-
If you need to review a pull request and are an employee of F5/NGINX, ask a member of @nginx/nginx-docs for help.
11+
If you are unable to assign yourself as an owner of an issue or a reviewer of a pull request, and are an employee of F5/NGINX, ask a member of the NGINX documentation team for help.
1812

1913
We encourage you to work with community contributors. If you participate in
2014
PRs, issues, discussions, and more, follow these guidelines:
@@ -27,4 +21,6 @@ PRs, issues, discussions, and more, follow these guidelines:
2721
- Do not include anything that even resembles PII.
2822
- Do not include information that is proprietary to and/or private within F5/NGINX.
2923

24+
As an F5/NGINX employee, if you have a GitHub account, you should be able to clone these repositories.
25+
3026
To protect F5/NGINX, the ability to merge pull requests is strictly limited to employees of F5/NGINX.

README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,6 @@ This repository contains user documentation for NGINX's products, as well as the
2424
Our documentation is written in Markdown, specifically the [Goldmark](https://github.com/yuin/goldmark) Markdown parser.
2525
We build our docs using [Hugo](https://gohugo.io) and host them in custom URLs on Azure.
2626

27-
## Publishing environments
28-
29-
When you submit a Pull Request (PR), our setup automatically builds the documentation with your proposed changes. You'll see the URL
30-
once you've submitted the PR.
31-
3227
## License
3328

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

0 commit comments

Comments
 (0)