Merge pull request #9181 from backstage/rugvip/pretty

docs: remove prettier configuration with proseWrap setting
This commit is contained in:
Patrik Oldsberg
2022-01-27 10:54:36 +01:00
committed by GitHub
11 changed files with 13 additions and 48 deletions
+1 -2
View File
@@ -25,8 +25,7 @@ Let's start by adding the following `auth` configuration in your
auth:
providers:
gcp-iap:
audience:
'/projects/<project number>/global/backendServices/<backend service id>'
audience: '/projects/<project number>/global/backendServices/<backend service id>'
```
You can find the project number and service ID in the Google Cloud Console.
+1 -2
View File
@@ -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/
+2 -4
View File
@@ -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
+1 -4
View File
@@ -173,10 +173,7 @@ jobs:
run: techdocs-cli generate --no-docker --verbose
- name: Publish docs site
run:
techdocs-cli publish --publisher-type awsS3 --storage-name
$TECHDOCS_S3_BUCKET_NAME --entity
$ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME
run: techdocs-cli publish --publisher-type awsS3 --storage-name $TECHDOCS_S3_BUCKET_NAME --entity $ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME
```
When the new repository is scaffolded or new documentation updates are
+1 -2
View File
@@ -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
@@ -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/<bucket>/<path>/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
+1 -2
View File
@@ -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
+3 -6
View File
@@ -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
-21
View File
@@ -1,21 +0,0 @@
/*
* Copyright 2020 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Use Object.assign since we haven't configured eslint for ... support in here
module.exports = Object.assign({}, require('@spotify/prettier-config'), {
proseWrap: 'always',
printWidth: 80,
});
+1 -2
View File
@@ -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