diff --git a/ADOPTERS.md b/ADOPTERS.md index 21b5b131a9..b95e20757d 100644 --- a/ADOPTERS.md +++ b/ADOPTERS.md @@ -84,4 +84,4 @@ | [Livspace](https://www.livspace.com) | [Praveen Kumar](https://github.com/praveen-livspace) | Developer portal, service catalog, tech docs, API docs and plugins | | [Just Eat Takeaway](https://www.justeattakeaway.com) | [Kim Wilson](https://github.com/kwilson541) | Our developer portal which centralises applications, reduces cognitive load and provides teams insights. | | [Hopin](https://hopin.com) | [Vladimir Glafirov](https://github.com/vglafirov), [Chloe Lee](https://github.com/msfuko) | Developer portal to streamline the development practices. Integrated with service catalog, software templates, application monitoring, tech docs and plugins. | -| [HBO Max](https://hbomax.com) | [@mdb](https://github.com/mdb), [@nesta219](https://github.com/nesta219), [@nmische](https://github.com/nmische), [@hbomark](https://github.com/hbomark) | Developer portal hosting service catalog and API documentation, as well as cloud infrastructure details, operational visibility tools, and a custom plugin for browsing notable platform change events, such as deployments and configuration updates. | +| [HBO Max](https://hbomax.com) | [@mdb](https://github.com/mdb), [@nesta219](https://github.com/nesta219), [@nmische](https://github.com/nmische), [@hbomark](https://github.com/hbomark) | Developer portal hosting service catalog and API documentation, as well as cloud infrastructure details, operational visibility tools, and a custom plugin for browsing notable platform change events, such as deployments and configuration updates. | diff --git a/docs/auth/google/gcp-iap-auth.md b/docs/auth/google/gcp-iap-auth.md index 29951951d1..7799517b5f 100644 --- a/docs/auth/google/gcp-iap-auth.md +++ b/docs/auth/google/gcp-iap-auth.md @@ -25,8 +25,7 @@ Let's start by adding the following `auth` configuration in your auth: providers: gcp-iap: - audience: - '/projects//global/backendServices/' + audience: '/projects//global/backendServices/' ``` You can find the project number and service ID in the Google Cloud Console. diff --git a/docs/features/kubernetes/configuration.md b/docs/features/kubernetes/configuration.md index 59f7c3d389..702e0c7736 100644 --- a/docs/features/kubernetes/configuration.md +++ b/docs/features/kubernetes/configuration.md @@ -368,5 +368,4 @@ for more info. [1]: https://cloud.google.com/kubernetes-engine [2]: https://cloud.google.com/docs/authentication/production#linux-or-macos -[3]: - https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/ +[3]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/ diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index 8fc60ea0d6..d5aad1c541 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -110,10 +110,8 @@ needs to be addressed. | CLI (for local development and generating docs) | [`@techdocs/cli`][techdocs/cli] | | Docker Container (for generating docs) | [`techdocs-container`][techdocs/container] | -[techdocs/frontend]: - https://github.com/backstage/backstage/blob/master/plugins/techdocs -[techdocs/backend]: - https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend +[techdocs/frontend]: https://github.com/backstage/backstage/blob/master/plugins/techdocs +[techdocs/backend]: https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend [techdocs/container]: https://github.com/backstage/techdocs-container [techdocs/cli]: https://github.com/backstage/techdocs-cli diff --git a/docs/features/techdocs/configuring-ci-cd.md b/docs/features/techdocs/configuring-ci-cd.md index 96d841eadf..c8af6e4d87 100644 --- a/docs/features/techdocs/configuring-ci-cd.md +++ b/docs/features/techdocs/configuring-ci-cd.md @@ -173,8 +173,7 @@ jobs: run: techdocs-cli generate --no-docker --verbose - name: Publish docs site - run: - techdocs-cli publish --publisher-type awsS3 --storage-name + run: techdocs-cli publish --publisher-type awsS3 --storage-name $TECHDOCS_S3_BUCKET_NAME --entity $ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME ``` diff --git a/docs/integrations/github/discovery.md b/docs/integrations/github/discovery.md index 467b29c759..39cb026703 100644 --- a/docs/integrations/github/discovery.md +++ b/docs/integrations/github/discovery.md @@ -71,6 +71,5 @@ which carries a much higher rate limit at GitHub. This is true for any method of adding GitHub entities to the catalog, but especially easy to hit with automatic discovery. -[rate limits]: - https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting +[rate limits]: https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting [github-apps]: ../../plugins/github-apps.md diff --git a/docs/integrations/google-cloud-storage/locations.md b/docs/integrations/google-cloud-storage/locations.md index bcdf612b9a..16e19ea350 100644 --- a/docs/integrations/google-cloud-storage/locations.md +++ b/docs/integrations/google-cloud-storage/locations.md @@ -51,5 +51,4 @@ console and browse the file you would like to import. Then copy the form. This url should look like `https://storage.cloud.google.com///catalog-info.yaml`. -[google gcs docs]: - https://cloud.google.com/docs/authentication/production#auth-cloud-implicit-nodejs +[google gcs docs]: https://cloud.google.com/docs/authentication/production#auth-cloud-implicit-nodejs diff --git a/docs/openapi/definitions/auth.yaml b/docs/openapi/definitions/auth.yaml index 032d89523d..863544c71a 100644 --- a/docs/openapi/definitions/auth.yaml +++ b/docs/openapi/definitions/auth.yaml @@ -86,8 +86,7 @@ paths: example: email - name: code in: query - description: - Short-term authorization code used to be exchanged for access tokens + description: Short-term authorization code used to be exchanged for access tokens required: true schema: type: string diff --git a/docs/plugins/analytics.md b/docs/plugins/analytics.md index 7fbd256e86..8a58677af6 100644 --- a/docs/plugins/analytics.md +++ b/docs/plugins/analytics.md @@ -42,13 +42,10 @@ To suggest an integration, please [open an issue][add-tool] for the analytics tool your organization uses. Or jump to [Writing Integrations][int-howto] to learn how to contribute the integration yourself! -[ga]: - https://github.com/backstage/backstage/blob/master/plugins/analytics-module-ga/README.md -[add-tool]: - https://github.com/backstage/backstage/issues/new?assignees=&labels=plugin&template=plugin_template.md&title=%5BAnalytics+Module%5D+THE+ANALYTICS+TOOL+TO+INTEGRATE +[ga]: https://github.com/backstage/backstage/blob/master/plugins/analytics-module-ga/README.md +[add-tool]: https://github.com/backstage/backstage/issues/new?assignees=&labels=plugin&template=plugin_template.md&title=%5BAnalytics+Module%5D+THE+ANALYTICS+TOOL+TO+INTEGRATE [int-howto]: #writing-integrations -[analytics-api-type]: - https://backstage.io/docs/reference/core-plugin-api.analyticsapi +[analytics-api-type]: https://backstage.io/docs/reference/core-plugin-api.analyticsapi ## Key Events diff --git a/docs/tutorials/backend-to-backend-auth.md b/docs/tutorials/backend-to-backend-auth.md index cd73a95c89..7de751be77 100644 --- a/docs/tutorials/backend-to-backend-auth.md +++ b/docs/tutorials/backend-to-backend-auth.md @@ -1,8 +1,7 @@ --- id: backend-to-backend-auth title: Backend-to-Backend Authentication -description: - Guide for authenticating API requests between Backstage plugin backends +description: Guide for authenticating API requests between Backstage plugin backends --- This tutorial describes the steps needed to handle _backend-to-backend