markdown source builds

Auto-generated via `{sandpaper}`
Source  : e5b2cbc
Branch  : main
Author  : Dimitrios Theodorakis <[email protected]>
Time    : 2024-12-19 14:19:54 +0000
Message : MetOffice#97 Add in a section on configuring GitHub settings

* Add in a section on configuring GitHub settings

* Address review comments

11-configuring-github.md

@@ -0,0 +1,113 @@
+---
+title: Configuring GitHub
+teaching: 15
+exercises: 0
+---
+
+::::::::::::::::::::::::::::::::::::::: objectives
+
+- Configure your GitHub profile and settings.
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+:::::::::::::::::::::::::::::::::::::::: questions
+
+- How do I edit my GitHub profile?
+- How do I change my notification preferences?
+- How do I change my organisation membership visibility,
+  and team memberships?
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+In this section we will look at configuring some optional GitHub
+settings on both a GitHub wide and repository level. 
+
+## Profile Settings
+
+You access your profile settings by navigating to:
+[https://github.com/settings/profile](https://github.com/settings/profile)
+
+Working down the page:
+
+1. Set your preferred name. This helps collaborators find you on GitHub.
+2. Set a public email, this also helps collaborators find your profile.
+   To keep your email address private click on **email settings**,
+   then tick the **Keep my email addresses private** checkbox.
+3. Set your pronouns.
+4. If you have a professional website you can add a link to the URL section.
+5. If you have an [ORCID](https://orcid.org/) you can link your GitHub
+   profile to your ID.
+6. If you would like to display your organisational affiliation add
+   `@<organisation-name>` to the Company section.
+
+You can also set a profile picture on this page.
+Click on the green **Update profile** button when you have
+finished making changes.
+
+![](fig/github-profile.png){alt='A screenshot of a users GitHub profile.'}
+
+You can also make profile changes directly from your profile
+by clicking on the **Edit profile** button.
+
+## Configuring Notifications
+
+To configure general notification settings navigate to:
+[https://github.com/settings/notifications](https://github.com/settings/notifications)
+
+Here you can choose a default email for notifications,
+and set up **Custom routing**.
+Custom routing allows you to specify different emails
+for each organisation you are a member of.
+
+In the **Subscriptions** section you can decide
+whether to receive notifications via GitHub, email, or both.
+
+### Repository Notifications
+
+You can customise notifications on a repository level.
+Since you created the `weather` repository you are
+automatically watching **All Activity**.
+Click on the **Unwatch** dropdown to change your notification settings.
+
+![](fig/github-repo-notifications.png){alt='A screenshot of the GitHub weather repo with the Unwatch dropdown expanded.'}
+
+The same dropdown will display **Watch** on repositories
+that do not belong to you.
+
+## Organisation Membership
+
+If you are a member of an organisation you can make your membership
+of the organisation public or private by navigating to:
+`https://github.com/orgs/<organisation-name>/people`
+
+Search for your name and click on the right hand dropdown
+to change your organisation visibility.
+
+![](fig/github-org-membership.png){alt='A screenshot of the GitHub organisation People settings for an organisation showing how to change your organisation visibility.'}
+
+The default visibility setting will depend on your organisation.
+If you set the visibility to public your membership will appear
+on your profile, `https://github.com/<your-username>/`,
+near the bottom left of the screen.
+
+## Teams Membership
+
+One across from the People settings are the Teams settings:
+`https://github.com/orgs/<organisation-name>/teams`.
+You can leave, request to join, or if you are an admin add members
+to your GitHub team here.
+[Teams](https://docs.github.com/en/organizations/organizing-members-into-teams/about-teams)
+let you manage access to repositories
+for a group of people all at once.
+Some organisations restrict the creation of GitHub teams to central admins.
+
+:::::::::::::::::::::::::::::::::::::::: keypoints
+
+- You access your GitHub profile settings by navigating to:
+  [https://github.com/settings/profile](https://github.com/settings/profile).
+- To configure general GitHub notification settings navigate to:
+  [https://github.com/settings/notifications](https://github.com/settings/notifications).
+- Click on the **Watch** or **Unwatch** repository dropdown button to
+  change notifications for specific repositories.
+
+::::::::::::::::::::::::::::::::::::::::::::::::::

config.yaml

@@ -72,6 +72,7 @@ episodes:
 - 08-github-interface.md
 - 09-github-history.md
 - 10-pull-requests.md
+- 11-configuring-github.md
 - End.md
 - 10-open.md
 - 11-licensing.md

md5sum.txt

@@ -1,7 +1,7 @@
 "file" "checksum" "built" "date"
 "CODE_OF_CONDUCT.md" "c93c83c630db2fe2462240bf72552548" "site/built/CODE_OF_CONDUCT.md" "2024-12-03"
 "LICENSE.md" "b24ebbb41b14ca25cf6b8216dda83e5f" "site/built/LICENSE.md" "2024-12-03"
-"config.yaml" "5249568369df2dd9f2c2dbe0bc4d0fd2" "site/built/config.yaml" "2024-12-18"
+"config.yaml" "63bad31d602badcc1d33437fc70cb758" "site/built/config.yaml" "2024-12-19"
 "index.md" "5805bcbdc567c8268e51d1c24d354dbe" "site/built/index.md" "2024-12-18"
 "episodes/01-basics.md" "17cd83bcf93ca43e33515ac7552905f8" "site/built/01-basics.md" "2024-12-18"
 "episodes/02-setup.md" "6d98278b0632471e50348256503c7c69" "site/built/02-setup.md" "2024-12-03"
@@ -16,6 +16,7 @@
 "episodes/08-github-interface.md" "2641c20c56244752c19d4536a7b2a00f" "site/built/08-github-interface.md" "2024-12-03"
 "episodes/09-github-history.md" "818a3286c4acb5d09044c76cc06ca7e3" "site/built/09-github-history.md" "2024-12-18"
 "episodes/10-pull-requests.md" "6404480d7f8f231e8d4e7502059423c4" "site/built/10-pull-requests.md" "2024-12-18"
+"episodes/11-configuring-github.md" "0c9291cd60576e3d698e23bd649beb8f" "site/built/11-configuring-github.md" "2024-12-19"
 "episodes/End.md" "cc53a997d59dbe79cf5dbdc65041870b" "site/built/End.md" "2024-12-18"
 "episodes/10-open.md" "c27c2606c8b6909c0117aea8f1e88fdd" "site/built/10-open.md" "2024-12-03"
 "episodes/11-licensing.md" "eeb26447e99a107a8cc00a37950d3877" "site/built/11-licensing.md" "2024-12-03"