Skip to content

Commit cd32786

Browse files
authored
feat: Move and update process documentation (#717)
This commit moves and updates some of the process documentation for the repository. This is an iterative process, which will continue to improve as time goes on. Some of the changes include: - Moving the closed contributions document into the documentation folder - Moving and reframing the F5/NGINX document as "Maintainers etiquette" - Moving and renaming the "Managing content with Hugo" document - Moving the style guide from the templates folder These files will likely be updated in a subsequent PR as we clarify the contribution process and user flow of other process artefacts, such as the pull request and issue templates. Although we do not draw attention to it, the templates folder is being retained for reference until the style guide and Hugo archetypes contain the relevant, useful information.
1 parent f205c7c commit cd32786

File tree

6 files changed

+24
-21
lines changed

6 files changed

+24
-21
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Contributing guidelines
22

3-
The following is a set of guidelines for community contributions to this
4-
project. We really appreciate your desire to contribute!
3+
The following is a set of guidelines for community contributions to this project.
54

6-
If you are an F5 employee, see the following additional guidance [For F5 Employees](./F5-NGINX-team-notes.md).
5+
We really appreciate your desire to contribute!
6+
7+
If you are an F5 employee, see the following additional guidance on [Maintainers etiquette](/documentation/maintainers-etiquette.md).
78

89
## Table of contents
910

@@ -12,8 +13,8 @@ If you are an F5 employee, see the following additional guidance [For F5 Employe
1213
- [Open a Discussion](#open-a-discussion)
1314
- [Submit a Pull Request](#submit-a-pull-request)
1415
- Review our [Git style guide](#git-style-guide)
15-
- Review our Documentation [style guide](./templates/style-guide.md)
16-
- Review our [Contributing guidelines for writers](./CONTRIBUTING_DOCS.md)
16+
- Review the [Writing style guide](/documentation/style-guide.md)
17+
- Review [Managing content with Hugo](/documentation/writing-hugo.md)
1718
- [Issue Lifecycle](#issue-lifecycle)
1819
- [Additional NGINX documentation](#additional-nginx-documentation)
1920
- [F5 Contributor License Agreement (CLA)](#f5-contributor-license-agreement)
@@ -51,6 +52,7 @@ our documentation as described in our [support](./SUPPORT.md) page.
5152
### Git style guide
5253

5354
- Keep a clean, concise and meaningful Git commit history on your branch, rebasing locally and squashing before you submit a PR
55+
- We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) formatting.
5456
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
5557
and summarized in the next few points:
5658

documentation/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This directory contains the documentation for the NGINX Documentation repository.
44

5-
It's used by the DocOps team to record how we configure our tools and instructions for certain precise tasks.
5+
It's used by the DocOps team to record how we use our tools and instructions for common tasks.
66

77
There's also documentation around our ways of working, and ideas of significance wider than the scope of an issue or pull request.
88

@@ -12,4 +12,8 @@ If you're interested in contributing to the [NGINX documentation website](https:
1212

1313
## Topics
1414

15+
- [Contributing closed content](/documentation/closed-contributions.md)
16+
- [Maintainers etiquette](/documentation/maintainers-etiquette.md)
17+
- [Managing content with Hugo](/documentation/writing-hugo.md)
1518
- [Proposals](/documentation/proposals/README.md)
19+
- [Writing style guide](/documentation/style-guide.md)

CLOSED_CONTRIBUTIONS.md renamed to documentation/closed-contributions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing guidelines for closed content
1+
# Contributing closed content
22

33
This document describes the process for authoring "closed content", which is content of a sensitive nature that cannot be publicised before release.
44

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
1-
# For F5/NGINX Employees
1+
# Maintainers etiquette
22

3-
This repository is public, and we do as much of our work as possible in the public as a commitment to open source.
4-
5-
Before new content is published at https://docs.nginx.com, it must be committed to this `documentation` repository.
6-
7-
If you are an F5 employee unable to assign yourself as an owner of an issue or a reviewer of a pull request, ask a member of the NGINX documentation team for help.
8-
9-
If your content cannot be publicized before release, it is handled differently: read the [Contributing guidelines for closed content](/CLOSED_CONTRIBUTIONS.md) document.
3+
This document is intended for the maintainers of the repository, who are any F5/NGINX employees that contribute to it.
104

115
We encourage you to work with community contributors. If you participate in PRs, issues, discussions, and more, follow these guidelines:
126

137
- Follow the [Code of Conduct](./CODE_OF_CONDUCT.md).
148
- Be helpful. We want to encourage people who contribute to continue.
15-
- If you need to say "no," here's [an example](https://github.com/nginx/documentation/pull/307#issuecomment-2748521932) of how we interact with the community.
9+
- If you need to say "no," here's [an example](https://github.com/nginx/documentation/pull/307#issuecomment-2748521932) of how to interact with the community.
1610
- Avoid references and links to internal content.
17-
- Do not include information about future releases, changes, or features, unless
18-
specifically authorized.
19-
- Do not include anything that even resembles PII.
11+
- Do not include information about future releases, changes, or features, unless specifically authorized.
12+
- Do not include anything that resembles PII.
2013
- Do not include information that is proprietary to and/or private within F5/NGINX.
2114

15+
This repository is public, and we do as much of our work as possible in the public as a commitment to open source.
16+
2217
As an F5/NGINX employee, if you have a GitHub account, you should be able to clone these repositories.
2318

19+
If your content cannot be visible before release, you should read the [Contributing guidelines for closed content](/CLOSED_CONTRIBUTIONS.md) document.
20+
2421
To protect F5/NGINX, the ability to merge pull requests is strictly limited to employees of F5/NGINX.
File renamed without changes.

CONTRIBUTING_DOCS.md renamed to documentation/writing-hugo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Contributing guidelines for writers
1+
# Managing content with Hugo
22

33
This page describes our guidelines on using [Hugo](https://gohugo.io/) to write documentation.
44

55
You will need [git](https://git-scm.com/) to interact with the repository and files: the content itself is written in Markdown.
66

77
Our workflow is to develop content locally, then submit a pull request once we've done our initial draft and editing passes.
88

9-
If you're an employee of F5/NGINX, also read [For F5/NGINX Employees](./F5-NGINX-team-notes.md).
9+
For guidance around how to write content, please check [the style guide](/documentation/style-guide.md).
1010

1111
## Setup
1212

0 commit comments

Comments
 (0)