From e124107523c9226f1356befb181fc2d0b4c780dd Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 27 Mar 2025 16:19:02 +0000 Subject: [PATCH 1/3] test --- CLOSED_CONTRIBUTIONS.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CLOSED_CONTRIBUTIONS.md b/CLOSED_CONTRIBUTIONS.md index ebe3368b3..2f9df8413 100644 --- a/CLOSED_CONTRIBUTIONS.md +++ b/CLOSED_CONTRIBUTIONS.md @@ -23,6 +23,23 @@ The process is as follows: You can get the URL through our internal communication channels: it will be represented in the following steps as ``. +## Steps + +To create closed content, add the closed repository as a remote to the main repository, then fetch. + +```shell +cd documentation +git remote add internal git@github.com:.git +git fetch +``` + +Check out the `documentation` branch, and use it to create a feature branch. **Ensuring that you prefix all branch names with `internal/`** + +```shell +git checkout internal/documentation +git checkout -b internal/feature +``` + To create closed content, first clone the internal repository: `git clone git@github.com:.git` From c45cd12b00ec591035756d93a5501aedcd50966c Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 27 Mar 2025 16:32:03 +0000 Subject: [PATCH 2/3] test --- CLOSED_CONTRIBUTIONS.md | 43 ++++++++++++----------------------------- 1 file changed, 12 insertions(+), 31 deletions(-) diff --git a/CLOSED_CONTRIBUTIONS.md b/CLOSED_CONTRIBUTIONS.md index 2f9df8413..16f1f735c 100644 --- a/CLOSED_CONTRIBUTIONS.md +++ b/CLOSED_CONTRIBUTIONS.md @@ -15,10 +15,11 @@ 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 ``. @@ -33,52 +34,32 @@ git remote add internal git@github.com:.git git fetch ``` -Check out the `documentation` branch, and use it to 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/`** ```shell git checkout internal/documentation git checkout -b internal/feature ``` -To create closed content, first clone the internal repository: +Once you've finished with your work, commit it and push it to the internal repository: -`git clone git@github.com:.git` - -Change into this new directory: - -`cd ` - -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 +```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 git@github.com:nginx/documentation.git -cd documentation -git add remote internal git@github.com:.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. \ No newline at end of file +Once the content changes have been merged in the open repository, they will synchronize back to the closed repository. \ No newline at end of file From e8b2ed9cb054b481a01c895790fddc0f57e362cf Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 27 Mar 2025 16:36:41 +0000 Subject: [PATCH 3/3] Update CLOSED_CONTRIBUTIONS.md --- CLOSED_CONTRIBUTIONS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CLOSED_CONTRIBUTIONS.md b/CLOSED_CONTRIBUTIONS.md index 16f1f735c..a43befae3 100644 --- a/CLOSED_CONTRIBUTIONS.md +++ b/CLOSED_CONTRIBUTIONS.md @@ -19,7 +19,7 @@ The process is as follows: - 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 close repository branch with a new branch in the open 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 can get the URL through our internal communication channels: it will be represented in the following steps as ``.