From b18a898919e881912513d88877075e3678253dc6 Mon Sep 17 00:00:00 2001 From: Mike Jang <3287976+mjang@users.noreply.github.com> Date: Tue, 15 Jul 2025 10:35:09 -0700 Subject: [PATCH 1/2] Update closed-contributions.md based on user testing --- documentation/closed-contributions.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/documentation/closed-contributions.md b/documentation/closed-contributions.md index cc0970362..9b5d3f449 100644 --- a/documentation/closed-contributions.md +++ b/documentation/closed-contributions.md @@ -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 ``. @@ -36,6 +38,12 @@ git remote add internal git@github.com:.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 @@ -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. @@ -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 an authorized user, 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. From 95e7ef509b85f176f397327c03ccd25a2b8e5077 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 16 Jul 2025 14:41:41 +0100 Subject: [PATCH 2/2] Update documentation/closed-contributions.md Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com> --- documentation/closed-contributions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/closed-contributions.md b/documentation/closed-contributions.md index 9b5d3f449..3564b9e74 100644 --- a/documentation/closed-contributions.md +++ b/documentation/closed-contributions.md @@ -75,6 +75,6 @@ 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 an authorized user, you can merge the changes without additional approvals. +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.