Skip to content

fix: Update closed-contributions.md based on user testing #819

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.

Sign up for GitHub

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 2 commits into from
Jul 16, 2025
Merged

fix: Update closed-contributions.md based on user testing #819

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b18a898
Update closed-contributions.md based on user testing
mjang Jul 15, 2025
95e7ef5
Update documentation/closed-contributions.md
ADubhlaoich Jul 16, 2025
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
15 changes: 14 additions & 1 deletion documentation/closed-contributions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,13 @@ This repository (https://github.com/nginx/documentation) is where we work by def
The process is as follows:

- Add the closed repository as a remote
- The closed repository is also known as `internal`
- 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
- Merge the changes from the remote (Closed) 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 do not have to get approvals a second time

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

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

You can verfiy access to the closed repository in your `.git/config` file. Look for the code block that corresponds to:

```
[remote "internal"]
```

Check out the remote `main` branch, and use it to create a feature branch. **Ensure that you prefix all branch names with `internal/`**

```shell
Expand All @@ -51,7 +59,7 @@ git commit
git push internal
```

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

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.

Expand All @@ -64,4 +72,9 @@ git merge internal/internal/feature
git push origin
```

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
repository, check the commit messages.

If you are a maintainer of https://github.com/nginx/documentation, you can merge the changes without additional approvals.

Once the content changes have been merged in the open repository, they will synchronize back to the closed repository.