Skip to content

Commit c3ca5b2

Browse files
committed
feat: Add closed contribution process
This commit adds a new document to explain the closed contribution process. As part of the changes, related content is updated from the existing documentation specific to F5 employees, decoupling this particular use case from general guidance. At a future point, both documents may be reorganised into alternate files as part of peripheral efforts to document ways of working.
1 parent c7234a7 commit c3ca5b2

File tree

2 files changed

+56
-5
lines changed

2 files changed

+56
-5
lines changed

CLOSED_CONTRIBUTIONS.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing guidelines for closed content
2+
3+
This document describes the process for authoring "closed content", which is content of a commercially sensitive nature that cannot be publicised before release.
4+
5+
Commercially sensitive content might include:
6+
7+
- Security content, including personally identifying information (PII).
8+
- Content / features that are not yet ready to be announced.
9+
10+
We work in public by default, so this process should only be used on a case by case basis by F5 employees. For standard content releases, review the [Contributing guidelines](/CONTRIBUTING.md)
11+
12+
## Overview
13+
14+
This repository (https://github.com/nginx/documentation) is where we work by default. It has a one-way sync to an internal repository, used for closed content.
15+
16+
You can get the URL through our internal communication channels: it will be represented in the following steps as `<closed-URL>`.
17+
18+
To create closed content, first clone the internal repository:
19+
20+
`git clone [email protected]:<closed-url>.git`
21+
22+
Change into this new directory:
23+
24+
`cd <closed-url>`
25+
26+
Check out the `documentation` branch:
27+
28+
`git checkout documentation`
29+
30+
Create a feature branch, **ensuring that you prefix all branch names with `internal/`**:
31+
32+
`git checkout -b internal/feature`
33+
34+
You can then continue on as normal:
35+
36+
```bash
37+
# Make documentation changes
38+
git add .
39+
git commit
40+
git push
41+
```
42+
43+
After you have iterated on the closed content, you can open a PR in the main repository by adding the closed repository as a remote.
44+
45+
```bash
46+
git clone [email protected]:nginx/documentation.git
47+
cd documentation
48+
git add remote internal [email protected]:<closed-url>.git
49+
git fetch internal internal/feature
50+
git checkout -b feature
51+
git merge internal/internal/feature
52+
git push origin feature
53+
```

F5-NGINX-team-notes.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# For F5/NGINX Employees
22

3-
This repository is a functional mirror. We want to do as much of our work as possible in the
4-
public repository. However, if you are working with:
3+
This repository is a functional mirror. We want to do as much of our work as possible in the public repository.
54

6-
- Security content, including personally identifying information (PII).
7-
- Content / features that are not yet ready to be announced.
5+
Content which cannot be publicised before release is handled slightly differently: please read the [Contributing guidelines for closed content](/CLOSED_CONTRIBUTIONS.md) document.
86

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.
7+
Before new content is published at https://docs.nginx.com, it must be commited to this `documentation` repository.
108

119
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, ask a member of the NGINX documentation team for help.
1210

0 commit comments

Comments
 (0)