generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 120
feat: Update closed documentation process #323
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 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 |
---|---|---|
|
@@ -15,53 +15,51 @@ This repository (https://github.com/nginx/documentation) is where we work by def | |
|
||
The process is as follows: | ||
|
||
- Create a branch with the prefix `internal/` in the closed repository | ||
- Add the closed repository as a remote | ||
- Create a remote branch with the prefix `internal/` in the closed repository | ||
- Open a pull request in the closed repository to get previews and request feedback | ||
- Once all stakeholders are happy with changes, close the pull request in the closed repository | ||
- Push the changes to the open (public) repository by adding the closed repository as a remote | ||
- Merge the changes from the remote close repository branch with a new branch in the open repository | ||
- Open a new pull request in the open repository, where it can be merged | ||
|
||
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: | ||
## Steps | ||
|
||
`git clone [email protected]:<closed-url>.git` | ||
To create closed content, add the closed repository as a remote to the main repository, then fetch. | ||
|
||
Change into this new directory: | ||
|
||
`cd <closed-url>` | ||
|
||
Check out the `documentation` branch: | ||
|
||
`git checkout documentation` | ||
```shell | ||
cd documentation | ||
git remote add internal [email protected]:<closed-url>.git | ||
git fetch | ||
``` | ||
|
||
Create a feature branch, **ensuring that you prefix all branch names with `internal/`**: | ||
Check out the `documentation` branch, and use it to create a feature branch. **Ensure that you prefix all branch names with `internal/`** | ||
|
||
`git checkout -b internal/feature` | ||
```shell | ||
git checkout internal/documentation | ||
git checkout -b internal/feature | ||
``` | ||
|
||
You can then continue on as normal: | ||
Once you've finished with your work, commit it and push it to the internal repository: | ||
|
||
```bash | ||
# Make documentation changes | ||
```shell | ||
git add . | ||
git commit | ||
git push | ||
git push internal | ||
``` | ||
|
||
Open a pull request when you are ready to receive feedback from stakeholders. | ||
|
||
After any iterative work, close the pull request. Since the closed repository is a mirror of the open one, we do not merge changes to it. | ||
|
||
You should instead open a pull request in the main repository by adding the closed repository as a remote. | ||
Change back to `main`, create a new branch, merge your internal branch and push to origin. | ||
|
||
```bash | ||
git clone [email protected]:nginx/documentation.git | ||
cd documentation | ||
git add remote internal [email protected]:<closed-url>.git | ||
git fetch internal internal/feature | ||
```shell | ||
git checkout main | ||
git checkout -b feature | ||
git merge internal/internal/feature | ||
git push origin feature | ||
git push origin | ||
``` | ||
|
||
After the content changes have been merged in the open repository, they will synchronize back to the closed repository. | ||
Once the content changes have been merged in the open repository, they will synchronize back to the closed repository. |
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.