Skip to content

fix: Clarify README-type files from the community PoV #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 31, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Testing: Describe any testing that you did.
Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an [issue](https://github.com/nginx/documentation/issues) on GitHub, ensure that you link to it here:

Closes #ISSUE

### Checklist
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The following is a set of guidelines for community contributions to this
project. We really appreciate your desire to contribute!

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

## Table of contents

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

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

## Submit a Pull Request

Expand Down
12 changes: 4 additions & 8 deletions F5-NGINX-team-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,9 @@ public repository. However, if you are working with:
- Security content, including personally identifying information (PII).
- Content / features that are not yet ready to be announced.

Make changes to the private `docs` repository. When you create a branch, start it with:
`internal/`.
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.

- The public `documentation` repository will reject branches that start with `internal/`.
- The private `docs` repository will accept branches _only_ if it includes `internal/`.

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.

If you need to review a pull request and are an employee of F5/NGINX, ask a member of @nginx/nginx-docs for help.
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.

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

As an F5/NGINX employee, if you have a GitHub account, you should be able to clone these repositories.

To protect F5/NGINX, the ability to merge pull requests is strictly limited to employees of F5/NGINX.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,6 @@ This repository contains user documentation for NGINX's products, as well as the
Our documentation is written in Markdown, specifically the [Goldmark](https://github.com/yuin/goldmark) Markdown parser.
We build our docs using [Hugo](https://gohugo.io) and host them in custom URLs on Azure.

## Publishing environments

When you submit a Pull Request (PR), our setup automatically builds the documentation with your proposed changes. You'll see the URL
once you've submitted the PR.

## License

[BSD 2-Clause "Simplified" License](/LICENSE)
Expand Down
Loading