Update branch name from master to main (#642)

All PlanktoScope repositories use the `main` branch for their main
branch. I renamed `master` branch to `main` for the
PlanktoScope/PlanktoScope repo as well.

Since I used the GitHub branch rename feature, all redirections should
work.

For local git repository please follow these instuctions:

```sh
git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a
```

Author: sonnyp

.github/workflows/build-controller.yml

@@ -3,7 +3,6 @@ name: Build the hardware controller
 on:
   push:
     branches:
-      - 'master'
       - 'main'
       - 'software/beta'
       - 'software/stable'

.github/workflows/build-os-bookworm.yml

@@ -3,7 +3,7 @@ name: build-os-bookworm
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
       - 'software/beta'
       - 'software/stable'
     tags:

.github/workflows/build-segmenter.yml

@@ -3,7 +3,6 @@ name: Build Docker container image for the segmenter
 on:
   push:
     branches:
-      - 'master'
       - 'main'
       - 'software/beta'
       - 'software/stable'
@@ -26,7 +25,7 @@ on:
 env:
   IMAGE_REGISTRY: ghcr.io/${{ github.repository_owner }}
   IMAGE_NAME: 'segmenter'
-  MAIN_BRANCH: 'master' # pushing to this branch will update the "edge" tag on the image
+  MAIN_BRANCH: 'main' # pushing to this branch will update the "edge" tag on the image
   BETA_BRANCH: 'software/beta' # pushing to this branch will update the "beta" tag on the image
   STABLE_BRANCH: 'software/stable' # pushing to this branch will update the "stable" tag on the image
   TAG_PREFIX: 'segmenter/v' # pushing tags with this prefix will add a version tag to the image and update the "latest" tag on the image

.github/workflows/documentation-build.yml

@@ -3,7 +3,7 @@ name: build-documentation
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
       - 'documentation/beta'
       - 'documentation/stable'
       - 'software/beta'
@@ -25,7 +25,7 @@ on:
 env:
   IMAGE_REGISTRY: ghcr.io/${{ github.repository_owner }}
   IMAGE_NAME: 'project-docs'
-  MAIN_BRANCH: 'master' # pushing to the main branch will update the "edge" tag on the image
+  MAIN_BRANCH: 'main' # pushing to the main branch will update the "edge" tag on the image
   BETA_BRANCH: 'documentation/beta' # pushing to this branch will update the "beta" tag on the image
   STABLE_BRANCH: 'documentation/stable' # pushing to this branch will update the "stable" tag on the image
   TAG_PREFIX: 'documentation/v' # pushing tags with this prefix will add a version tag to the image and update the "latest" tag on the image

.github/workflows/documentation-deploy-edge.yml

@@ -3,7 +3,7 @@ name: deploy-documentation/edge
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
     paths:
       - 'documentation/**'
       - 'hardware/**'

CHANGELOG.md

@@ -15,7 +15,7 @@ All dates in this file are given in the [UTC time zone](https://en.wikipedia.org
 - (System: networking) If you plug in a supported USB Wi-Fi dongle into the PlanktoScope, now it will by default automatically create a Wi-Fi hotspot network from that Wi-Fi dongle - regardless of whether the PlanktoScope's internal Wi-Fi module is configured to also create the same Wi-Fi hotspot network or to connect to some external Wi-Fi network. This means that the PlanktoScope now supports creating its own Wi-Fi hotspot while simultaneously being connected to the internet via a Wi-Fi network, if you plug in a USB Wi-Fi dongle.
 - (System: networking) If the PlanktoScope is connected to a Wi-Fi network with a captive portal, you should be able to access and proceed through the captive portal from a computer/phone connected to the PlanktoScope.
 - (System: networking) Firewalld is now enabled, and default firewall policies are provided (via Forklift) for the `public` and `nm-shared` firewall zones. This means that if you want to access any additional ports besides the ports for programs provided with the standard PlanktoScope OS from other devices, now you must add configurations to open those additional ports, e.g. via drop-in configuration snippets in `/etc/firewalld/zones.d`.
-- (Developers) Developer Mode and [Tips and Tricks page](https://github.com/PlanktoScope/PlanktoScope/blob/master/documentation/docs/community/contribute/tips-and-tricks.md)
+- (Developers) [Tips and Tricks page](https://github.com/PlanktoScope/PlanktoScope/blob/main/documentation/docs/community/contribute/tips-and-tricks.md)
 - (System) Enable [CQE](https://www.raspberrypi.com/news/sd-cards-and-bumper/) for significantly faster sdcard speed (Raspberry PI 5 only)
 - (System) Enable [SDRAM tuning](https://www.jeffgeerling.com/blog/2024/raspberry-pi-boosts-pi-5-performance-sdram-tuning) improvements for faster processing
 

controller/pyproject.toml

@@ -19,7 +19,7 @@ authors = ["Romain Bazile <romain@oceantrotter.org>"]
 license = "GPL-3.0-or-later"
 readme = "README.md"
 homepage = "https://www.planktoscope.org"
-repository = "https://github.com/PlanktoScope/PlanktoScope/tree/master/controller"
+repository = "https://github.com/PlanktoScope/PlanktoScope/tree/main/controller"
 documentation = "https://docs.planktoscope.community/"
 keywords = ["planktoscope"]
 classifiers = [

documentation/README.md

@@ -8,7 +8,7 @@ This directory contains the PlanktoScope's documentation system. Documentation s
 
 You can view the published documentation at the following URLs:
 
-- <https://docs-edge.planktoscope.community/>: this shows the "edge" (i.e. development) version of documentation on the `master` branch of the main PlanktoScope repository at https://github.com/PlanktoScope/PlanktoScope . Note that this version probably contains errors and broken content, and it is not an official release of the documentation. This version of the documentation is hosted as a way for documentation maintainers to preview changes while working together across pull requests.
+- <https://docs-edge.planktoscope.community/>: this shows the "edge" (i.e. development) version of documentation on the `main` branch of the main PlanktoScope repository at https://github.com/PlanktoScope/PlanktoScope . Note that this version probably contains errors and broken content, and it is not an official release of the documentation. This version of the documentation is hosted as a way for documentation maintainers to preview changes while working together across pull requests.
 - <https://docs-beta.planktoscope.community/>: this shows the "beta" version of documentation on the `beta` branch of the main PlanktoScope repository. This version is shown to beta testers; it probably has problems, but it is more reliable than the "edge" version
 - <https://docs.planktoscope.community>: this shows the "stable" version of documentation on the `stable` branch of the main PlanktoScope repository. This is the up-to-date version of PlanktoScope documentation which all PlanktoScope users should refer to as the official documentation website.
 
@@ -68,4 +68,4 @@ poetry run poe build
 
 #### Publishing your changes
 
-To publish your changes, make a [pull request](https://github.com/PlanktoScope/PlanktoScope/pulls) on our GitHub repository with a branch titled `feature/docs-<description of your changes>` (e.g. `feature/docs-fix-broken-link` or `feature/docs-improve-assembly-instructions`), and configure the pull request to merge the branch into the `master` branch. Once we merge the pull request, your changes will be published to the "edge" version of our documentation website (see the above "View the documentation" section of this README for the URL of the "edge" version of our documentation website).
+To publish your changes, make a [pull request](https://github.com/PlanktoScope/PlanktoScope/pulls) on our GitHub repository with a branch titled `feature/docs-<description of your changes>` (e.g. `feature/docs-fix-broken-link` or `feature/docs-improve-assembly-instructions`), and configure the pull request to merge the branch into the `main` branch. Once we merge the pull request, your changes will be published to the "edge" version of our documentation website (see the above "View the documentation" section of this README for the URL of the "edge" version of our documentation website).

documentation/docs/community/contribute/github.md

@@ -11,17 +11,17 @@ This repository is also a good way to get involved. Please fill in an issue if y
 ## Assumptions
 
 1. **You're familiar with [git](https://git-scm.com/) and the [Merge Request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)(PR) workflow.**
-2. **You've read the PlanktoScope [documentation](../../index.md).
+2. **You've read the PlanktoScope [documentation](../../index.md).**
 3. **You know about the PlanktoScope [community on Slack](https://planktoscope.slack.com/). Please use this for help.**
 
 ## How to Contribute
 
 1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/PlanktoScope/PlanktoScope/issues) or [open a new one](https://github.com/PlanktoScope/PlanktoScope/issues/new/choose).
-2. Once done, [fork the PlanktoScope repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) in your Github account. Ask a mastertainer if you want your issue to be checked before making a PR.
+2. Once done, [fork the PlanktoScope repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) in your Github account. Ask a maintainer if you want your issue to be checked before making a PR.
 3. [Create a new Git branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository).
-4. Review the [Development Workflow](#development-workflow) section that describes the steps to mastertain the repository.
+4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintainer the repository.
 5. Make the changes on your branch.
-6. [Submit the branch as a PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) pointing to the `master` branch of the master fabcity-os-core-chart repository. A mastertainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer. We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/PlanktoScope/PlanktoScope/releases).
+6. [Submit the branch as a PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) pointing to the `main` branch of the main PlanktoScope repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer. We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/PlanktoScope/PlanktoScope/releases).
 
 ## Git Guidelines
 
@@ -47,8 +47,8 @@ Some notes on PRs:
 
 - [Convert your PR as a draft]() if your changes are a work in progress: no one will review it until you pass your PR as ready for review.<br>
   The draft PR can be very useful if you want to show that you are working on something and make your work visible.
-- The branch related to the PR must be **up-to-date with `master`** before merging. Fortunately, this project [integrates a bot]() to automatically enforce this requirement without the PR author having to do it manually.
-- All PRs must be reviewed and approved by at least one mastertainer.
+- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot]() to automatically enforce this requirement without the PR author having to do it manually.
+- All PRs must be reviewed and approved by at least one maintainer.
 - The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs]().
 
 ## Release Process (for internal team only)
@@ -64,8 +64,8 @@ _[Read more about this]()._
 
 ⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration]().
 
-⚠️ Every PR that is merged to `master` introducing changes to the PlanktoScope needs to modify the file [``](), by increasing the version of the chart accordingly.
+⚠️ Every PR that is merged to `main` introducing changes to the PlanktoScope needs to modify the file [``](), by increasing the version of the chart accordingly.
 
-Every PR that is merged to `master` triggers the automated release process, as specified at [``](). A GitHub Action will be triggered and publish a new release on the GitHub repository [releases](). This will enable users to start using the new version of the chart immediately after publishing.
+Every PR that is merged to `main` triggers the automated release process, as specified at [``](). A GitHub Action will be triggered and publish a new release on the GitHub repository [releases](). This will enable users to start using the new version of the chart immediately after publishing.
 
 Thank you again for reading this through, we can not wait to begin to work with you if you made your way through this contributing guide ❤️

documentation/docs/community/contribute/tips-and-tricks.md

@@ -15,11 +15,11 @@ This page provides useful snippets and how-tos while developing software for the
 
 ## Development OS
 
-You can find the latest build of PlanktoScope OS in [actions](https://github.com/PlanktoScope/PlanktoScope/actions/workflows/build-os-bookworm.yml?query=branch%3Amaster)
+You can find the latest build of PlanktoScope OS in [actions](https://github.com/PlanktoScope/PlanktoScope/actions/workflows/build-os-bookworm.yml?query=branch%main)
 
 It is built upon [Raspberry Pi OS Lite 64-bit](https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-64-bit).
 
-1. Choose the branch (e.g. `master`)
+1. Choose the branch (e.g. `main`)
 2. Click on the most recent action in the table
 3. Download one of the Artifact depending on your PlanktoScope hardware
 4. Run `unzip filename.zip` to extract files
@@ -82,7 +82,7 @@ git config --global user.name "Your Name"
 git remote set-url origin git@github.com:PlanktoScope/PlanktoScope.git
 
 git fetch origin
-git checkout master
+git checkout main
 ```
 
 </details>
@@ -166,7 +166,7 @@ https://lloydrochester.com/post/hardware/libgpiod-intro-rpi/
 
 This is a quick setup guide. See also
 
-- [documentation README](https://github.com/PlanktoScope/PlanktoScope/blob/master/documentation/README.md)
+- [documentation README](https://github.com/PlanktoScope/PlanktoScope/blob/main/documentation/README.md)
 - [Writing Documentation](./documentation.md)
 
 Install dependencies: