Mirror primary repo to documentation repo

Set up a new GitHub Actions workflow to mirror the primary repository's
master branch to the public documentation repository. This requires the
use of a GitHub access token that has permission to read and write to
both repositories (and create workflows).

Note we do a full clone of the repository otherwise we can't force push
all changes to the documentation repository.

Now the documentation repository will only have a master branch, remove
any references to the develop branch.

Author: mudge

.github/workflows/mirror.yml

@@ -0,0 +1,19 @@
+name: Mirror repository
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  mirror:
+    runs-on: [self-hosted, web]
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: master
+          token: ${{ secrets.DOCUMENTATION_REPO_TOKEN }}
+          fetch-depth: 0
+      - run: git remote add documentation https://github.com/raspberrypi/documentation.git
+      - run: git push --force documentation master

CONTRIBUTING.md

@@ -15,17 +15,15 @@ To contribute or update documentation:
 
 1. Create a fork of this repository on your GitHub account.
 
-1. Make changes in your fork. Start from the default `develop` branch.
+1. Make changes in your fork. Start from the default `master` branch.
 
 1. Read our [style guide](https://github.com/raspberrypi/style-guide/blob/master/style-guide.md) to ensure that your changes are consistent with the rest of our documentation. Since Raspberry Pi is a British company, be sure to include all of your extra `u`s and transfigure those `z`s (pronounced 'zeds') into `s`s!
 
 1. [Open a pull request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) against this repository.
 
 1. The maintainers will assess and copy-edit the PR. This can take anywhere from a few minutes to a few days, depending on the size of your PR, the time of year, and the availability of the maintainers.
 
-1. After making any requested improvements to your PR, the maintainers will accept the PR and merge your changes into `develop`.
-
-1. When the maintainers next release the documentation by merging `develop` into `master`, your changes will go public on the production documentation site.
+1. After making any requested improvements to your PR, the maintainers will accept the PR and merge your changes into `master`, making them public on the production documentation site.
 
 Alternatively, [open an issue](https://github.com/raspberrypi/documentation/issues) to discuss proposed changes.
 

README.md

@@ -1,9 +1,9 @@
 <div align="center">
   <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/raspberrypi/documentation/refs/heads/develop/pi_dark.svg">
-    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/raspberrypi/documentation/refs/heads/develop/pi_light.svg">
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/raspberrypi/documentation/refs/heads/master/pi_dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/raspberrypi/documentation/refs/heads/master/pi_light.svg">
     <img alt="Raspberry Pi: computers and microcontrollers"
-         src="https://raw.githubusercontent.com/raspberrypi/documentation/refs/heads/develop/pi_light.svg"
+         src="https://raw.githubusercontent.com/raspberrypi/documentation/refs/heads/master/pi_light.svg"
          width="16%">
   </picture>
 
@@ -19,4 +19,4 @@ This repository contains the source and tools used to build the [Raspberry Pi Do
 
 ## Licence
 
-The Raspberry Pi documentation is [licensed](https://github.com/raspberrypi/documentation/blob/develop/LICENSE.md) under a Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA). Documentation tools (everything outside of the `documentation/` subdirectory) are licensed under the [BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause) licence.
+The Raspberry Pi documentation is [licensed](https://github.com/raspberrypi/documentation/blob/master/LICENSE.md) under a Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA). Documentation tools (everything outside of the `documentation/` subdirectory) are licensed under the [BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause) licence.

_config.yml

@@ -21,7 +21,6 @@ url: "https://www.raspberrypi.com/documentation" # the base hostname & protocol
 githuburl: "https://github.com/raspberrypi/documentation/"
 mainsite: https://raspberrypi.com/
 githubbranch: master
-githubbranch_edit: develop
 
 # Build settings
 theme: minima

scripts/create_build_adoc.py

@@ -54,7 +54,7 @@ def check_no_markdown(filename):
     with open(github_edit) as edit_fh:
         edit_template = edit_fh.read()
         template_vars = {
-            'github_edit_link': os.path.join(site_config['githuburl'], 'blob', site_config['githubbranch_edit'], src_adoc)
+            'github_edit_link': os.path.join(site_config['githuburl'], 'blob', site_config['githubbranch'], src_adoc)
         }
         edit_text = re.sub(r'{{\s*(\w+)\s*}}', lambda m: template_vars[m.group(1)], edit_template)
 

scripts/create_build_adoc_include.py

@@ -36,7 +36,7 @@ def check_no_markdown(filename):
     with open(github_edit) as edit_fh:
         edit_template = edit_fh.read()
         template_vars = {
-            'github_edit_link': os.path.join(site_config['githuburl'], 'blob', site_config['githubbranch_edit'], src_adoc)
+            'github_edit_link': os.path.join(site_config['githuburl'], 'blob', site_config['githubbranch'], src_adoc)
         }
         edit_text = re.sub(r'{{\s*(\w+)\s*}}', lambda m: template_vars[m.group(1)], edit_template)