Skip to content

Commit 49eb893

Browse files
robmarcerclaude
andauthored
Fix capitalisation: Github → GitHub throughout handbook (#5030)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 46c8d46 commit 49eb893

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

src/handbook/company/guides/git.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ navTitle: Using Git
55

66
## Background
77

8-
[Git](#git) is a way for a team to create written content, track any changes to that content, and seek approval for any changes to become the [Published](#publish) version of that content on [Live](#live). [Git](#git) can be used in many ways, our developers use it to write the code which makes FlowFuse work. In this guide we are focusing on the process of working with documents within our company [Handbook](#handbook) or website. We will use [Git](#git)'s terminology to describe how we are working. This guide also assumes you are using [Github](#github).com to edit the [Handbook](#handbook) and website.
8+
[Git](#git) is a way for a team to create written content, track any changes to that content, and seek approval for any changes to become the [Published](#publish) version of that content on [Live](#live). [Git](#git) can be used in many ways, our developers use it to write the code which makes FlowFuse work. In this guide we are focusing on the process of working with documents within our company [Handbook](#handbook) or website. We will use [Git](#git)'s terminology to describe how we are working. This guide also assumes you are using [GitHub](#github).com to edit the [Handbook](#handbook) and website.
99

1010
When making changes to a [Project](#project) at least two people have to agree that the changes should be Published. In most cases those two people would be yourself and a [Reviewer](#reviewer).
1111

@@ -60,7 +60,7 @@ You may be asked to conduct a Pull Request Review. This means that someone else
6060

6161
The first step to editing content is to create a [Branch](#branch) of that content. A [Branch](#branch) is a complete copy of the [Project](#project). Creating a [Branch](#branch) allows you to edit the content without those edits changing the [Live](#live) copy of a [Project](#project).
6262

63-
Navigate to the Project within [Github](#github) you want to work on, that would usually be [our website](https://github.com/FlowFuse/website) or [Handbook](https://github.com/FlowFuse/handbook).
63+
Navigate to the Project within [GitHub](#github) you want to work on, that would usually be [our website](https://github.com/FlowFuse/website) or [Handbook](https://github.com/FlowFuse/handbook).
6464

6565
![Create a new Branch](../../images/git-how-to/new-branch-1.png)
6666

@@ -98,7 +98,7 @@ I will work on the file until I think it's ready for a colleague to review the c
9898

9999
I am now ready to request a [Review](#review) of my work from a colleague. To do this I need to create a [Pull Request](#pull-request). Once you create the [Pull Request](#pull-request) an alert will be sent to your colleagues asking them for feedback on your work.
100100

101-
[Github](#github) gives you an easy to find button to create a [Pull Request](#pull-request) for your current work.
101+
[GitHub](#github) gives you an easy to find button to create a [Pull Request](#pull-request) for your current work.
102102

103103
![Create a Pull Request](../../images/git-how-to/create-a-pr-1.gif "@skip")
104104

@@ -148,9 +148,9 @@ The process to save changes to a [Branch](#branch) of a [Project](#project).
148148

149149
An app to help us collaboratively manage changes to documents. You can read more [here](https://git-scm.com/) but we'd advise you don't unless you are a developer as Git has a lot of features and terminology which you don't need to understand at this point.
150150

151-
### Github
151+
### GitHub
152152

153-
A website which allows you to manage [Git](#git). Github also allows you to communicate with your colleagues about changes you are making.
153+
A website which allows you to manage [Git](#git). GitHub also allows you to communicate with your colleagues about changes you are making.
154154

155155
### Handbook
156156

src/handbook/engineering/ops/deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Each change pushed to the repositories `main` branch initiates the process.
3333
Node package publish process is defined in the file `.github/workflows/publish.yml` in each repository while container images build steps can be found in `.github/workflows/*-containers.yml` files in [helm repository](https://github.com/FlowFuse/helm/tree/main/.github/workflows).
3434

3535
Each package has its dedicated code repository. Due to the security limitations of GitHub Actions, there is no possibility to access the pipeline from one repository to another.
36-
Therefore, there is a need to use a dedicated [Github App](https://docs.github.com/en/apps/overview) to access repositories and trigger the build process of the dependent package. The process of creating such GitHub App is described in the [GitHub documentation](https://docs.github.com/en/developers/apps/creating-a-github-app).
36+
Therefore, there is a need to use a dedicated [GitHub App](https://docs.github.com/en/apps/overview) to access repositories and trigger the build process of the dependent package. The process of creating such GitHub App is described in the [GitHub documentation](https://docs.github.com/en/developers/apps/creating-a-github-app).
3737
Because such GitHub App imitates a regular user, it is necessary to include `workflow_dispatch` event in the dependent workflow definition.
3838

3939
Example of job responsible for triggering dependent pipeline:

src/handbook/marketing/customer-stories.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ meta:
1010

1111
A customer story is the same as a case study, these are helpful in illustrating how Node-RED and FlowFuse can be useful for our potential customers. The process would be as follows:
1212

13-
1. Raise an issue for the content in our private [Github repository](https://github.com/FlowFuse/marketing){rel="nofollow"}.
13+
1. Raise an issue for the content in our private [GitHub repository](https://github.com/FlowFuse/marketing){rel="nofollow"}.
1414
2. Add it to the [Content Calendar Project](https://github.com/orgs/FlowFuse/projects/21) and schedule it.
1515
3. If you want to work on the content immediately please triage the issue into our [development board](https://github.com/orgs/FlowFuse/projects/1/views/33).
1616
4. Conduct an interview call with the customer using Google Meet to record and transcribe the conversation. Record interviews using Fathom as outlined in the [Sales Meetings guide](/handbook/sales/meetings/).

0 commit comments

Comments
 (0)