Skip to content

Commit

Permalink
vale: prune accepted vocabulary
Browse files Browse the repository at this point in the history
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
  • Loading branch information
Rugvip committed Apr 27, 2022
1 parent 098e40c commit 89bb536
Show file tree
Hide file tree
Showing 14 changed files with 16 additions and 24 deletions.
8 changes: 0 additions & 8 deletions .github/vale/Vocab/Backstage/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ airbrake
Anddddd
Apdex
api
Api
apis
args
asciidoc
async
Atlassian
Expand All @@ -19,7 +16,6 @@ autoscaling
Autoscaling
autoselect
Avro
aws
backported
backporting
Bigtable
Expand All @@ -38,7 +34,6 @@ changesets
Changesets
chanwit
Chanwit
ci
CI/CD
classname
cli
Expand Down Expand Up @@ -127,7 +122,6 @@ hoc
horizontalpodautoscalers
Hostname
hotspots
html
http
https
Iain
Expand Down Expand Up @@ -314,7 +308,6 @@ templaters
Templaters
theia
thumbsup
toc
todo
tolerations
Tolerations
Expand All @@ -339,7 +332,6 @@ unregistration
untracked
upsert
upvote
url
URIs
URLs
utils
Expand Down
2 changes: 1 addition & 1 deletion STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ There are a few things to pay attention to, in order to make the documentation s

API documenter will not recognize arrow functions as functions, but rather as a constant that shows up in the list of exported variables. By declaring functions using the `function` keyword, they will show up in the list of functions. They will also get a much nicer documentation page for the individual function that shows information about parameters and return types.

This also extends to React components, since API documenter doesn't have any special handling of those. By always defining exported React components using the `function` keyword, we make them show up among the list of functions in the API reference, where they are then easily discoverable through the `(props)` args (which you should be sure to include!).
This also extends to React components, since API documenter doesn't have any special handling of those. By always defining exported React components using the `function` keyword, we make them show up among the list of functions in the API reference, where they are then easily discoverable through the `(props)` argument (which you should be sure to include!).

![image](https://user-images.githubusercontent.com/4984472/133120461-59d74c3e-ebd9-44f9-900d-cc30f54a3cd2.png)

Expand Down
4 changes: 2 additions & 2 deletions contrib/docs/tutorials/help-im-behind-a-corporate-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ if (process.env.HTTPS_PROXY) {

If your development environment is in the cloud (like with [AWS Cloud9](https://aws.amazon.com/cloud9/) or an instance of [Theia](https://theia-ide.org/)), you will need to update your configuration.

You will probably need to make some changes in `app-config.yaml` (or another config file like `app-config.local.yaml` if you've created it, see the [configuration doc](https://backstage.io/docs/conf/#supplying-configuration)).
The exact values will depend on your setup but for instance, if your public url is `https://your-public-url.com` and the port `3000` and `8080` are open:
You will probably need to make some changes in `app-config.yaml` (or another config file like `app-config.local.yaml` if you've created it, see the [configuration doc](https://backstage.io/docs/conf/#supplying-configuration)).
The exact values will depend on your setup but for instance, if your public URL is `https://your-public-url.com` and the port `3000` and `8080` are open:

```yaml
app:
Expand Down
2 changes: 1 addition & 1 deletion docs/auth/add-auth-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ name.
### Test the new provider

You can `curl -i localhost:7007/api/auth/providerA/start` and which should
provide a `302` redirect with a `Location` header. Paste the url from that
provide a `302` redirect with a `Location` header. Paste the URL from that
header into a web browser and you should be able to trigger the authorization
flow.

Expand Down
2 changes: 1 addition & 1 deletion docs/auth/github/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The GitHub provider is a structure with three configuration keys:
- `clientSecret`: The client secret tied to the generated client ID.
- `enterpriseInstanceUrl` (optional): The base URL for a GitHub Enterprise
instance, e.g. `https://ghe.<company>.com`. Only needed for GitHub Enterprise.
- `callbackUrl` (optional): The callback url that GitHub will use when
- `callbackUrl` (optional): The callback URL that GitHub will use when
initiating an OAuth flow, e.g.
`https://your-intermediate-service.com/handler`. Only needed if Backstage is
not the immediate receiver (e.g. one OAuth app for many backstage instances).
Expand Down
2 changes: 1 addition & 1 deletion docs/conf/writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ $file: ./my-secret.txt

The `$include` keyword can be used to load configuration values from an external
file. It's able to load and parse data from `.json`, `.yml`, and `.yaml` files.
It's also possible to include a url fragment (`#`) to point to a value at the
It's also possible to include a URL fragment (`#`) to point to a value at the
given path in the file, using a dot-separated list of keys.

For example, the following would read `my-secret-key` from `my-secrets.json`:
Expand Down
4 changes: 2 additions & 2 deletions docs/features/techdocs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ GitLab, etc.) and passes the files to the generator for next steps.

There are two kinds of preparers available -

1. Common Git Preparer - Uses `git clone` on any repository url.
2. Url Reader - Uses source code hosting provider's API to download files.
1. Common Git Preparer - Uses `git clone` on any repository URL.
2. URL Reader - Uses source code hosting provider's API to download files.
(Faster and recommended)

### TechDocs Generator
Expand Down
2 changes: 1 addition & 1 deletion docs/features/techdocs/using-cloud-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ Since the new SDK doesn't use the old way authentication, we don't need the keys

The new SDK needs the OpenStack Swift connection URL for connecting the Swift.
So you need to add a new key called `openStackSwift.swiftUrl` and give the
OpenStack Swift url here. Example url should look like that:
OpenStack Swift URL here. Example URL should look like that:
`https://example.com:6780/swift/v1`

##### That's it!
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/gerrit/locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ a structure with up to six elements:
- `baseUrl` (optional): Needed if the Gerrit instance is not reachable at
the base of the `host` option (e.g. `https://gerrit.company.com`) set the
address here. This is the address that you would open in a browser.
- `cloneUrl` (optional): The base url for HTTP clones. Will default to `baseUrl` if
- `cloneUrl` (optional): The base URL for HTTP clones. Will default to `baseUrl` if
not set. The address used to clone a repo is the `cloneUrl` plus the repo name.
- `gitilesBaseUrl` (optional): This is needed for creating a valid user-friendly url
- `gitilesBaseUrl` (optional): This is needed for creating a valid user-friendly URL
that can be used for browsing the content of the provider. If not set a default
value will be created in the same way as the "baseUrl" option. There is no
requirement to have Gitiles for the Backstage Gerrit integration but without it
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/google-cloud-storage/locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ you can check [this documentation page][google gcs docs].
To use this integration to import entities from a GCS bucket go to the Google
console and browse the file you would like to import. Then copy the
`Authenticated URL` and paste it into the text box in the `register component`
form. This url should look like
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
2 changes: 1 addition & 1 deletion docs/tutorials/using-backstage-proxy-within-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ calling `${backend-url}/api/proxy/<your-proxy-uri>`. The reason why
`backend-url` is referenced is because the backstage backend creates and runs
the proxy. Backstage is structured in such a way that you could run the
backstage frontend independently of the backend. So when calling your API you
need to prepend the backend url to your http call.
need to prepend the backend URL to your http call.

The recommended pattern for calling out to services is to wrap your calls in a
[Utility API](../api/utility-apis.md). This section describes the steps to wrap
Expand Down
2 changes: 1 addition & 1 deletion plugins/api-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ The Swagger UI package by expects to have a route to `/oauth2-redirect.html` whi
the redirect callback for the OAuth2 Authorization Code flow, however, this file is not installed
by this plugin.

Grab a copy of [oauth2-redirect.html](https://github.com/swagger-api/swagger-ui/blob/master/dist/oauth2-redirect.html)
Grab a copy of [`oauth2-redirect.html`](https://github.com/swagger-api/swagger-ui/blob/master/dist/oauth2-redirect.html)
and put it in the `app/public/` directory in order to enable Swagger UI to complete this redirection.

This also may require you to adjust `Content Security Policy` header settings of your Backstage application, so that the script in `oauth2-redirect.html` can be executed. Since the script is static we can add the hash of it directly to our CSP policy, which we do by adding the following to the `csp` section of the app configuration:
Expand Down
2 changes: 1 addition & 1 deletion plugins/cost-insights/src/alerts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export class CostInsightsClient extends CostInsightsApi {

### Custom Setup

Default properties such as the title, subtitle and instructions page url can be overridden - even default UI such as chart itself. Additionally, alerts can be extended to support actions such as snoozing or dismissing.
Default properties such as the title, subtitle and instructions page URL can be overridden - even default UI such as chart itself. Additionally, alerts can be extended to support actions such as snoozing or dismissing.

![project-growth-alert-custom](../assets/project-growth-alert-custom.png)

Expand Down
2 changes: 1 addition & 1 deletion plugins/kubernetes-backend/examples/dice-roller/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This can be used to run the kubernetes plugin locally against a mock service.
## Steps

1. Start minikube
2. Get the Kubernetes master base url `kubectl cluster-info`
2. Get the Kubernetes master base URL `kubectl cluster-info`
3. Apply manifests `kubectl apply -f dice-roller-manifests.yaml`
4. Get service account token (see below)
5. Start Backstage UI and backend
Expand Down

0 comments on commit 89bb536

Please sign in to comment.