Skip to content

Commit fd0dff0

Browse files
authored
Merge pull request #6701 from ronaldbarendse/chore/github-casing
Use correct GitHub casing
2 parents 12e358a + f6b97da commit fd0dff0

File tree

110 files changed

+272
-270
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+272
-270
lines changed

.github/styles/UmbracoDocs/Brands.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,6 @@ swap:
88
slack: "'Slack'"
99
azure: "'Azure'"
1010
gitbook: "'GitBook'"
11+
Gitbook: "'GitBook'"
1112
github: "'GitHub'"
13+
Github: "'GitHub'"

.github/workflows/Vale-Linter.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ jobs:
1111
with:
1212
fail_on_error: true
1313
env:
14-
# Required, set by GitHub actions automatically:
14+
# Required, set by GitHub Actions automatically:
1515
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
1616
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

10/umbraco-cms/extending/filesystemproviders/azure-blob-storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The correct package will have be installed in your project.
4444

4545
## Configuring Blob storage
4646

47-
The next step is to configure your blob storage. There are multiple approaches for this, but in this document, we're going to do it through `appsettings.json`. For more configuration options, see the [readme](https://github.com/umbraco/Umbraco.StorageProviders#umbracostorageproviders) on the Github repository.
47+
The next step is to configure your blob storage. There are multiple approaches for this, but in this document, we're going to do it through `appsettings.json`. For more configuration options, see the [readme](https://github.com/umbraco/Umbraco.StorageProviders#umbracostorageproviders) on the GitHub repository.
4848

4949
Open up your `appsettings.json` file and add the connection string and container name under `Umbraco:Storage:AzureBlob:Media`. Your Umbraco section of appsettings will look something like this:
5050

10/umbraco-cms/extending/packages/creating-a-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ The `Title`, `Description`, `PackageTags` came with the template and we added so
147147
| ------------------------ | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
148148
| Version | 1.0.0 | This is automatically set to 1.0.0 but can be changed as appropriate. |
149149
| Authors | Your name | Here you get to take credit for your awesome work! |
150-
| PackageProjectUrl | https://umbraco.com | This URL will be shown as the package's URL when others install it. It will likely be a Github repository, or similar. |
150+
| PackageProjectUrl | https://umbraco.com | This URL will be shown as the package's URL when others install it. It will likely be a GitHub repository, or similar. |
151151
| PackageLicenseExpression | MIT | The license is set to MIT. Please consider how you want your package licensed. If in doubt when deciding an open-source license there are [good resources available](https://choosealicense.com/licenses/). |
152152

153153
### Pack it

10/umbraco-cms/extending/packages/example-package-repository.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Finally there's an [example Umbraco website](https://github.com/umbraco/Umbraco.
4444

4545
As well as the projects, the following files are added to the solution:
4646

47-
- [.artifactignore](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.artifactignore) - used by AzureDevOps services to [control which files are uploaded when you publish](https://learn.microsoft.com/en-us/azure/devops/artifacts/reference/artifactignore?view=azure-devops). This helps to reduce pipeline execution time.
47+
- [.artifactignore](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.artifactignore) - used by Azure DevOps services to [control which files are uploaded when you publish](https://learn.microsoft.com/en-us/azure/devops/artifacts/reference/artifactignore?view=azure-devops). This helps to reduce pipeline execution time.
4848
- [.editorconfig](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.editorconfig) - used to [enforce consistent coding styles](https://editorconfig.org/) for multiple developers working on the same project across editors and IDEs.
4949
- [.gitignore](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.gitignore) - controls which files are added to source control.
5050
- [.globalconfig](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.globalconfig) - provides [further styling rules for the project files, even if stored outside of the project directory](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files#global-analyzerconfig).
@@ -58,7 +58,7 @@ As well as the projects, the following files are added to the solution:
5858

5959
## Build and Deployment
6060

61-
We use AzureDevOps pipelines for continuous integration and releasing new versions of the package. The definition of how the project is built is defined in a `.yaml` file that's part of the source code repository.
61+
We use Azure DevOps pipelines for continuous integration and releasing new versions of the package. The definition of how the project is built is defined in a `.yaml` file that's part of the source code repository.
6262

6363
The file can be found [here](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/azure-pipeline%20-%20Umbraco.AuthorizedServices.yml).
6464

@@ -68,13 +68,13 @@ Even if using another tool it may be worth reviewing how we have setup our pipel
6868

6969
The build consists of two stages: building the solution and running unit tests. Only if both succeed is the build as a whole considered successful.
7070

71-
![AzureDevOps build pipeline](./images/azuredevops-build.png)
71+
![Azure DevOps build pipeline](./images/azuredevops-build.png)
7272

7373
### Releasing the Package
7474

75-
We release the package manually in AzureDevOps, with a two stage process. Firstly we release to a "pre-releases" feed, and then after manual approval, to NuGet.
75+
We release the package manually in Azure DevOps, with a two stage process. Firstly we release to a "pre-releases" feed, and then after manual approval, to NuGet.
7676

77-
![AzureDevOps release pipeline](./images/azuredevops-release.png)
77+
![Azure DevOps release pipeline](./images/azuredevops-release.png)
7878

7979

8080

10/umbraco-cms/extending/ui-library.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You can also change the stylesheet of custom properties to see how the component
2424

2525
## Installing the UI Library Components
2626

27-
You can download the UI Library package from [Github](https://github.com/umbraco/Umbraco.UI/tree/v1/contrib/packages).
27+
You can download the UI Library package from [GitHub](https://github.com/umbraco/Umbraco.UI/tree/v1/contrib/packages).
2828

2929
If you are installing a component via npm, there are two ways to import it:
3030

@@ -40,7 +40,7 @@ If you are installing a component via npm, there are two ways to import it:
4040
'@umbraco-ui/uui-button/lib/uui-button.element';
4141
```
4242

43-
For more information on installation, Content Delivery Networks (CDN), or included components, see the [Readme file in the Github](https://github.com/umbraco/Umbraco.UI#readme) project.
43+
For more information on installation, Content Delivery Networks (CDN), or included components, see the [Readme file in the GitHub](https://github.com/umbraco/Umbraco.UI#readme) project.
4444

4545
## Getting Started with the UI Library
4646

10/umbraco-cms/reference/security/cookies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ services.AddSession(options =>
3333
});
3434
```
3535

36-
For information on the rest of the cookies, see the [Constants-Web.cs](https://github.com/umbraco/Umbraco-CMS/blob/v10/contrib/src/Umbraco.Core/Constants-Web.cs) file on Github.
36+
For information on the rest of the cookies, see the [Constants-Web.cs](https://github.com/umbraco/Umbraco-CMS/blob/v10/contrib/src/Umbraco.Core/Constants-Web.cs) file on GitHub.

10/umbraco-cms/tutorials/creating-and-distributing-a-package.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ The content in this article is valid _only_ for Umbraco version 8. For Umbraco v
1212
* [Creating a test site locally](creating-and-distributing-a-package.md#creating-a-test-site-locally)
1313
* [Creating a package from the backoffice](creating-and-distributing-a-package.md#creating-a-package-from-the-backoffice)
1414
* [Creating a draft package on Our](creating-and-distributing-a-package.md#creating-a-draft-package-on-our)
15-
* [Pushing your package to Github](creating-and-distributing-a-package.md#pushing-your-package-to-github)
15+
* [Pushing your package to GitHub](creating-and-distributing-a-package.md#pushing-your-package-to-github)
1616
* [Pack up your package locally using UmbPack](creating-and-distributing-a-package.md#pack-up-your-package-locally-using-umbpack)
1717
* [Pushing your package to Our using UmbPack](creating-and-distributing-a-package.md#pushing-your-package-to-our-using-umbpack)
18-
* [Deploy your package using Github Actions](creating-and-distributing-a-package.md#deploy-your-package-using-github-actions)
18+
* [Deploy your package using GitHub Actions](creating-and-distributing-a-package.md#deploy-your-package-using-github-actions)
1919
* [Archive older versions on push](creating-and-distributing-a-package.md#archive-older-versions-on-push)
2020

2121
## Prerequisites
2222

2323
To run this tutorial you will need the following:
2424

2525
* Be able to run an Umbraco site locally
26-
* Git + Github account
26+
* Git + GitHub account
2727
* [Our Umbraco member account](https://our.umbraco.com/member/Signup) with access to upload packages
2828
* UmbPack installed
2929
* Umbraco Package templates installed
@@ -60,7 +60,7 @@ It will show you all the options you have for creating a new Umbraco site + pack
6060
dotnet new umbraco-v8-package -n PackageWorkshop -d
6161
```
6262

63-
This will create a new package called `PackageWorkshop`, and add a custom Dashboard for us to use in this tutorial. By default you will also get a Github Action added that we will return to later.
63+
This will create a new package called `PackageWorkshop`, and add a custom Dashboard for us to use in this tutorial. By default you will also get a GitHub Action added that we will return to later.
6464

6565
After running you will have a folder called `PackageWorkshop`, inside that you will have your site and solution files. So try to open it in Visual Studio or Rider by opening the `PackageWorkshop.sln` file.
6666

@@ -234,13 +234,13 @@ Now your package is on Our, and if the "Go live" button is clicked it is visible
234234

235235
The next step is to make it a bit simpler to deploy updates to the package. It is perfectly fine to log in here and upload a new version each time. The next steps will show an easier way though.
236236

237-
## Pushing your package to Github
237+
## Pushing your package to GitHub
238238

239239
If you are creating a package in order to share it with others it is a great idea to also share the source code. It is the open source way.
240240

241-
To share it, and make it easier to manage and deploy updates we will set up a Github repository for the package. This tutorial assumes you know what Github is, and that you have an account.
241+
To share it, and make it easier to manage and deploy updates we will set up a GitHub repository for the package. This tutorial assumes you know what GitHub is, and that you have an account.
242242

243-
Create a fresh repo, with no readme, gitignore or license - do not choose a repository template (set to 'No Template'). On the second screen it will give you a command to push an existing repository to the new Github repo, should look like this but with your own user in the link:
243+
Create a fresh repo, with no readme, gitignore or license - do not choose a repository template (set to 'No Template'). On the second screen it will give you a command to push an existing repository to the new GitHub repo, should look like this but with your own user in the link:
244244

245245
```none
246246
git remote add origin https://github.com/jmayntzhusen/package-workshop.git
@@ -257,26 +257,26 @@ git add .
257257
git commit -m "Initial commit, dashboard package"
258258
```
259259

260-
At this point you have your solution in a local git repository, and we can then use the command from Github to push it up:
260+
At this point you have your solution in a local git repository, and we can then use the command from GitHub to push it up:
261261

262262
```none
263263
git remote add origin https://github.com/jmayntzhusen/package-workshop.git
264264
git branch -M main
265265
git push -u origin main
266266
```
267267

268-
Now you have it all on Github:
268+
Now you have it all on GitHub:
269269

270-
![Github repo](<images/github-repo (1).png>)
270+
![GitHub repo](<images/github-repo (1).png>)
271271

272272
## Pack up your package locally using UmbPack
273273

274-
At this point you know how to create a package from the backoffice, upload it to Our and push your changes to Github. That's what it takes to create and maintain a package.
274+
At this point you know how to create a package from the backoffice, upload it to Our and push your changes to GitHub. That's what it takes to create and maintain a package.
275275

276276
If you want to make changes and push a new version you can carry out the following steps:
277277

278278
* Create the new package in the backoffice
279-
* Sync your code to Github
279+
* Sync your code to GitHub
280280
* Go to Our and upload a new zip version
281281
* Set that to the current version
282282
* Optionally archive the previous one
@@ -399,15 +399,15 @@ You can edit all of these defaults, and also specify older versions of your pack
399399

400400
So at this point we can work on our package locally, build a new version within seconds by running the pack command and then deploy it to Our using the push command.
401401

402-
Not easy enough for you? Let's try automating this entire thing with Github actions then.
402+
Not easy enough for you? Let's try automating this entire thing with GitHub Actions then.
403403

404-
## Deploy your package using Github Actions
404+
## Deploy your package using GitHub Actions
405405

406-
If you think back to the beginning when we set up our sites using the Package Templates you may remember that by default you get a Github action installed as well.
406+
If you think back to the beginning when we set up our sites using the Package Templates you may remember that by default you get a GitHub action installed as well.
407407

408408
If you check out the `~/.github/workflows` folder in your solution, you will see there is a readme file and a build.yml file.
409409

410-
The build.yml file is used by Github actions, which will perform some tasks for you when certain criteria are met. If you haven't worked with continuous integration and deployment (CI/CD) before, then this may seem like magic - but don't worry we will run through the commands.
410+
The build.yml file is used by GitHub Actions, which will perform some tasks for you when certain criteria are met. If you haven't worked with continuous integration and deployment (CI/CD) before, then this may seem like magic - but don't worry we will run through the commands.
411411

412412
The build.yml file contains several things, let's have a quick overview:
413413

@@ -433,9 +433,9 @@ The action that it performs is what is under `jobs:build:steps`. There is a step
433433
It sets the version of the package to be what we've set in the release tag based on a previous step.
434434
{% endhint %}
435435

436-
Below this there is another step to push the package to Our, which again is like our approach locally - except now we add the API key as a Github secret so it's not public to everyone.
436+
Below this there is another step to push the package to Our, which again is like our approach locally - except now we add the API key as a GitHub secret so it's not public to everyone.
437437

438-
![Github secret](images/gh-secret.png)
438+
![GitHub secret](images/gh-secret.png)
439439

440440
```yml
441441
- name: Push to Our
@@ -444,7 +444,7 @@ Below this there is another step to push the package to Our, which again is like
444444

445445
With these 2 commands and a few previous ones setting up the prerequisite build and nuget tools it is now ready to be fully automated.
446446

447-
Ensure you have set a Github secret with the name `UMBRACO_DEPLOY_KEY` and the value of the key from Our, and then go to your local solution and uncomment the UmbPack push command in the \~/.github/workflows/build.yml file.
447+
Ensure you have set a GitHub secret with the name `UMBRACO_DEPLOY_KEY` and the value of the key from Our, and then go to your local solution and uncomment the UmbPack push command in the \~/.github/workflows/build.yml file.
448448

449449
Then make sure it is added and committed locally:
450450

@@ -454,14 +454,14 @@ git commit -m "Enable umbpack push in GH action"
454454
git push
455455
```
456456

457-
Your solution and Github repo are now in sync, and the umbpack commands in the Github action are enabled and ready to run. Final step is to create a release tag and push it to Github:
457+
Your solution and GitHub repo are now in sync, and the umbpack commands in the GitHub action are enabled and ready to run. Final step is to create a release tag and push it to GitHub:
458458

459459
```none
460460
git tag release/1.0.0
461461
git push origin release/1.0.0
462462
```
463463

464-
At this point you can go to Github and visit the Action tab to see your Github action run. When it's completed successfully you can go to your package overview on Our and see the package there.
464+
At this point you can go to GitHub and visit the Action tab to see your GitHub action run. When it's completed successfully you can go to your package overview on Our and see the package there.
465465

466466
## Archive older versions on push
467467

10/umbraco-commerce/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,4 @@ This section contains the release notes for Umbraco Commerce 10 including all ch
9090

9191
## Legacy release notes
9292

93-
You can find the release notes for **Vendr** in the [Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md).
93+
You can find the release notes for **Vendr** in the [Change log file on GitHub](../../13/umbraco-commerce/changelog-archive/Vendr-core.md).

10/umbraco-commerce/upgrading/version-specific-upgrades.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ See the [Migrate from Vendr to Umbraco Commerce guide](../upgrading/migrate-from
2020

2121
## Legacy version specific upgrade notes
2222

23-
You can find the version specific upgrade notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/tree/umbraco-eol-versions).&#x20;
23+
You can find the version specific upgrade notes for versions out of support in the [Legacy documentation on GitHub](https://github.com/umbraco/UmbracoDocs/tree/umbraco-eol-versions).&#x20;

0 commit comments

Comments
 (0)