Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
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
53 changes: 53 additions & 0 deletions CLOSED_CONTRIBUTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contributing guidelines for closed content

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

Sensitive content might include:

- Security content, including personally identifying information (PII).
- Content / features that are not yet ready to be announced.

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)

## Overview

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.

You can get the URL through our internal communication channels: it will be represented in the following steps as `<closed-URL>`.

To create closed content, first clone the internal repository:

`git clone [email protected]:<closed-url>.git`

Change into this new directory:

`cd <closed-url>`

Check out the `documentation` branch:

`git checkout documentation`

Create a feature branch, **ensuring that you prefix all branch names with `internal/`**:

`git checkout -b internal/feature`

You can then continue on as normal:

```bash
# Make documentation changes
git add .
git commit
git push
```

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.

```bash
git clone [email protected]:nginx/documentation.git
cd documentation
git add remote internal [email protected]:<closed-url>.git
git fetch internal internal/feature
git checkout -b feature
git merge internal/internal/feature
git push origin feature
```
8 changes: 3 additions & 5 deletions F5-NGINX-team-notes.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# For F5/NGINX Employees

This repository is a functional mirror. We want to do as much of our work as possible in the
public repository. However, if you are working with:
This repository is public, and we do as much of our work as possible in the public as a commitment to open source.

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

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

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.

Expand Down