Skip to content

Commit cab2b43

Browse files
authored
Merge branch 'main' into nic/upgrade-instructions
2 parents 1ce25d2 + 58c4a46 commit cab2b43

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

documentation/closed-contributions.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@ This repository (https://github.com/nginx/documentation) is where we work by def
1818
The process is as follows:
1919

2020
- Add the closed repository as a remote
21+
- The closed repository is also known as `internal`
2122
- Create a remote branch with the prefix `internal/` in the closed repository
2223
- Open a pull request in the closed repository to get previews and request feedback
2324
- Once all stakeholders are happy with changes, close the pull request in the closed repository
2425
- Merge the changes from the remote (Closed) repository branch with a new branch in the open repository
2526
- Open a new pull request in the open repository, where it can be merged
27+
- You do not have to get approvals a second time
2628

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

@@ -36,6 +38,12 @@ git remote add internal [email protected]:<closed-url>.git
3638
git fetch --all
3739
```
3840

41+
You can verfiy access to the closed repository in your `.git/config` file. Look for the code block that corresponds to:
42+
43+
```
44+
[remote "internal"]
45+
```
46+
3947
Check out the remote `main` branch, and use it to create a feature branch. **Ensure that you prefix all branch names with `internal/`**
4048

4149
```shell
@@ -51,7 +59,7 @@ git commit
5159
git push internal
5260
```
5361

54-
Open a pull request when you are ready to receive feedback from stakeholders.
62+
Open a pull request when you are ready to receive feedback from stakeholders. You'll see the pull request in the internal repository.
5563

5664
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.
5765

@@ -64,4 +72,9 @@ git merge internal/internal/feature
6472
git push origin
6573
```
6674

75+
This allows you to open a _new_ pull request in the open repository. To verify that pull request reflects the changes made in the closed
76+
repository, check the commit messages.
77+
78+
If you are a maintainer of https://github.com/nginx/documentation, you can merge the changes without additional approvals.
79+
6780
Once the content changes have been merged in the open repository, they will synchronize back to the closed repository.

0 commit comments

Comments
 (0)