generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 123
feat: Add closed contribution process #316
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
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c3ca5b2
feat: Add closed contribution process
ADubhlaoich af93819
Update F5-NGINX-team-notes.md
ADubhlaoich 8d4e2db
Apply suggestions from code review
ADubhlaoich 111d695
feat: Add more explicit detail about process
ADubhlaoich 21bd339
Merge branch 'main' into docs/add-closed-process
ADubhlaoich 9aeffa5
feat: Additional changes to team notes
ADubhlaoich 29e164c
Update F5-NGINX-team-notes.md
mjang 5a9641e
Update CLOSED_CONTRIBUTIONS.md
ADubhlaoich File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 commercially sensitive nature that cannot be publicised before release. | ||
|
|
||
| Commercially sensitive content might include: | ||
ADubhlaoich marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - 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. | ||
ADubhlaoich marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```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 | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.