diff --git a/docs-ui/README.md b/docs-ui/README.md index b943f1ce7c..bbdee195b4 100644 --- a/docs-ui/README.md +++ b/docs-ui/README.md @@ -4,7 +4,7 @@ Backstage UI is our internal UI library built for Backstage. We built this websi ## How to run locally -This website is built with Next.js and it is hosted on Github pages. To run it locally, you can run the following command: +This website is built with Next.js and it is hosted on GitHub pages. To run it locally, you can run the following command: ```bash yarn start @@ -12,7 +12,7 @@ yarn start ## Deployment -Deployments are done automatically when a PR is merged into the `master` branch. We host the website using Github pages. +Deployments are done automatically when a PR is merged into the `master` branch. We host the website using GitHub pages. ## Maintaining Component Changelogs diff --git a/docs/contribute/doc-style-guide.md b/docs/contribute/doc-style-guide.md index 1d6438e68d..7ffe6bf147 100644 --- a/docs/contribute/doc-style-guide.md +++ b/docs/contribute/doc-style-guide.md @@ -371,3 +371,11 @@ the site. | app-config | Use code style: `app-config.yaml`. | | open source | Two words, lowercase (unless starting a sentence). | | backend system | Lowercase when referring to the Backstage backend framework. | + +## General word list + +A list of general terms and words to be used consistently across the site. + +| Term | Usage | +| :----- | :-------------------------------------------------------------- | +| GitHub | Use GitHub in documentation. In code, use `github` (lowercase). | diff --git a/docs/features/software-templates/index.md b/docs/features/software-templates/index.md index a2b7a2efea..2c2337f7ab 100644 --- a/docs/features/software-templates/index.md +++ b/docs/features/software-templates/index.md @@ -41,7 +41,7 @@ internally. ![Enter some variables](../../assets/software-templates/template-picked.png) -Templates generally consist of a set of steps, and each step can have its own set of required or optional inputs, as you can see in the image below we are now prompted to input some Github repository information. +Templates generally consist of a set of steps, and each step can have its own set of required or optional inputs, as you can see in the image below we are now prompted to input some GitHub repository information. ![Enter Backstage vars](../../assets/software-templates/template-picked-2.png) diff --git a/docs/golden-path/adoption/001-getting-started.md b/docs/golden-path/adoption/001-getting-started.md index df5577527b..3a77889589 100644 --- a/docs/golden-path/adoption/001-getting-started.md +++ b/docs/golden-path/adoption/001-getting-started.md @@ -19,7 +19,7 @@ At a high level, Backstage is a framework for building developer portals. When i A few examples, -> My company tracks everything with spreadsheets. We have a list of all Github repos and who owns them, but it's becoming more and more of an issue to keep up to date. Teams aren't proactively updating it when new projects are created and it quickly falls out of date with reorgs and team charter changes. +> My company tracks everything with spreadsheets. We have a list of all GitHub repos and who owns them, but it's becoming more and more of an issue to keep up to date. Teams aren't proactively updating it when new projects are created and it quickly falls out of date with reorgs and team charter changes. Backstage can help! We provide a core plugin called Software Catalog that automates this process. Teams are asked to maintain a file in their repo with this ownership information and it gets automatically ingested into Backstage where you can view all projects in a single location. @@ -31,7 +31,7 @@ It's important to note that Backstage shouldn't be fully replacing these tools, > We have been struggling recently with getting teams to use a standard template for new services. There's no standard set of libraries these services are using or standard infra management. It's increasingly difficult as a platform team to manage everything. -Backstage can help here too! The Scaffolder provides a templating framework that you can plug a Golden Path implementation to. Similar to Github template repos, this can provide a standard base for teams to create based off of. +Backstage can help here too! The Scaffolder provides a templating framework that you can plug a Golden Path implementation to. Similar to GitHub template repos, this can provide a standard base for teams to create based off of. > Our platform teams have been getting more and more support requests to help debug onboarding steps. We've documented these areas really well and there are plenty of examples in Git, but teams keep running into the same issues. It's always either a bad copy paste or they forget to update a template variable. We've started looking into a custom templating solution for this. diff --git a/docs/golden-path/adoption/002-leadership-buy-in.md b/docs/golden-path/adoption/002-leadership-buy-in.md index ecb937c6e2..10bc371843 100644 --- a/docs/golden-path/adoption/002-leadership-buy-in.md +++ b/docs/golden-path/adoption/002-leadership-buy-in.md @@ -7,7 +7,7 @@ description: How to build a case for Backstage adoption and secure leadership su ## Summary -In this section, we'll be going over what leadership needs to hear to buy in to your pitch for a developer portal. We expect that you have a good idea of the problem that you want Backstage to solve at your company. If not, we recommend you start small. Look for something that is consistently frustrating developers you work with (this can include you). User interviews are a great way to better understand what needs to improve. It may be IT blocking the creation of new Github repos or databases. It might be 5 hours per week of manual toil that your whole organization has to do. It might be a slow time to production for new services or slow provisioning of test environments. Every company will be different. There is no one size fits all answer we can give you - and if we could, it wouldn't be well-tailored for _your_ leadership team. +In this section, we'll be going over what leadership needs to hear to buy in to your pitch for a developer portal. We expect that you have a good idea of the problem that you want Backstage to solve at your company. If not, we recommend you start small. Look for something that is consistently frustrating developers you work with (this can include you). User interviews are a great way to better understand what needs to improve. It may be IT blocking the creation of new GitHub repos or databases. It might be 5 hours per week of manual toil that your whole organization has to do. It might be a slow time to production for new services or slow provisioning of test environments. Every company will be different. There is no one size fits all answer we can give you - and if we could, it wouldn't be well-tailored for _your_ leadership team. ## Milestones diff --git a/docs/golden-path/create-app/installing-plugins.md b/docs/golden-path/create-app/installing-plugins.md index f5f5931220..73ddb075d6 100644 --- a/docs/golden-path/create-app/installing-plugins.md +++ b/docs/golden-path/create-app/installing-plugins.md @@ -49,7 +49,7 @@ backend.import(`@scope/package`) to your `packages/backend/src/index.ts` file alongside the other entries. Saving the file will trigger a hot reload and just like that your new plugin is available and usable. For advanced cases, there may be required config for the plugin that you'll have to set. That config will (or should) be documented by the plugin in their `README`. -You may also need to add backend modules to provide the additional functionality in the plugin that you're looking for. Backend modules are further extensions to backend code that can provide tailored functionality, good examples are catalog processor modules that add support for Github, LDAP and AWS software entities. Modules install the exact same way as backend plugins. Installing a module may also require additional configuration, which should also be documented in the plugin's `README`. +You may also need to add backend modules to provide the additional functionality in the plugin that you're looking for. Backend modules are further extensions to backend code that can provide tailored functionality, good examples are catalog processor modules that add support for GitHub, LDAP and AWS software entities. Modules install the exact same way as backend plugins. Installing a module may also require additional configuration, which should also be documented in the plugin's `README`. ### Installing a Frontend Plugin diff --git a/docs/golden-path/deployment/__meta__.md b/docs/golden-path/deployment/__meta__.md index 7c5107e368..b452b30002 100644 --- a/docs/golden-path/deployment/__meta__.md +++ b/docs/golden-path/deployment/__meta__.md @@ -21,7 +21,7 @@ Users are expected to already have created a Backstage application, but we have ## Prerequisites -The user should already have created a Backstage application (`create-app`) and pushed their code to an origin in a source control management system (Github, Gitlab, etc). They should have a handle on how their company builds and deploys code. +The user should already have created a Backstage application (`create-app`) and pushed their code to an origin in a source control management system (GitHub, Gitlab, etc). They should have a handle on how their company builds and deploys code. ## Deploying Backstage @@ -47,7 +47,7 @@ Use this section to walk through database options, talk through why Postgres is ### Authentication -By default, Backstage lets users login through a guest user. While that's a good fit for a solid developer experience locally, it can open up security holes when it's deployed to production. For that reason, you should configure a different authentication provider. See the docs at `auth/*`. A solid choice is Github authentication - your target audience with a developer portal should already have access to Github. +By default, Backstage lets users login through a guest user. While that's a good fit for a solid developer experience locally, it can open up security holes when it's deployed to production. For that reason, you should configure a different authentication provider. See the docs at `auth/*`. A solid choice is GitHub authentication - your target audience with a developer portal should already have access to GitHub. ## Deployment Guides diff --git a/docs/tooling/local-dev/linking-local-packages.md b/docs/tooling/local-dev/linking-local-packages.md index c2bb55722c..ec57108941 100644 --- a/docs/tooling/local-dev/linking-local-packages.md +++ b/docs/tooling/local-dev/linking-local-packages.md @@ -11,7 +11,7 @@ those changes within your Backstage application, you will need to link the two together: ```text -~/backstage // cloned from Github +~/backstage // cloned from GitHub ~/my-backstage-application // generated using npx ``` diff --git a/microsite/sidebars.ts b/microsite/sidebars.ts index 565c09feb4..3435bc5333 100644 --- a/microsite/sidebars.ts +++ b/microsite/sidebars.ts @@ -415,7 +415,7 @@ export default { 'integrations/gerrit/locations', 'integrations/gerrit/discovery', ]), - sidebarElementWithIndex({ label: 'Github' }, [ + sidebarElementWithIndex({ label: 'GitHub' }, [ 'integrations/github/locations', 'integrations/github/discovery', 'integrations/github/org', diff --git a/typedoc.json b/typedoc.json index 608b95a515..86c2d533e8 100644 --- a/typedoc.json +++ b/typedoc.json @@ -3,6 +3,6 @@ "name": "Backstage", "navigationLinks": { "Docs": "https://backstage.io/docs", - "Github": "https://github.com/backstage/backstage" + "GitHub": "https://github.com/backstage/backstage" } }