docs/features/software-templates: review fixes

Co-authored-by: Ben Lambert <ben@blam.sh>
This commit is contained in:
Patrik Oldsberg
2020-08-12 10:27:25 +02:00
parent 42f949b465
commit 63d1bd80cc
2 changed files with 13 additions and 4 deletions
@@ -316,10 +316,10 @@ group of people in an organizational structure.
Describes the following entity kind:
| Field | Value |
| ---------------- | ----------------------- |
| `apiVersion` | `backstage.io/v1alpha1` |
| `Kind: Template` | `Template` |
| Field | Value |
| ------------ | ----------------------- |
| `apiVersion` | `backstage.io/v1alpha1` |
| `kind` | `Template` |
A Template describes a skeleton for use with the Scaffolder. It is used for
describing what templating library is supported, and also for documenting the
@@ -9,6 +9,9 @@ to set that up can be found [here](./TODO.md).
## Installing @backstage/plugin-scaffolder
> **Note that if you used `npx @backstage/create-app`, the plugin may already be
> present**
`The scaffolder frontend plugin should be installed in your`app`package, which is created as a part of`@backstage/create-app`.
To install the package, run:
@@ -53,6 +56,9 @@ work!
## Installing @backstage/plugin-scaffolder-backend
> **Note that if you used `npx @backstage/create-app`, the plugin may already be
> present**
The scaffolder backend should be installed in your `backend` package, which is
created as a part of `@backstage/create-app`. To install the package, run:
@@ -168,6 +174,9 @@ docs on creating private GitHub access tokens is available
Note that the need for private GitHub access tokens will be replaced with GitHub
Apps integration further down the line.
> **Right now it is only possible to scaffold repositories inside GitHub
> organizations, and not under personal accounts.**
The GitHub access token is passed along using the `GITHUB_ACCESS_TOKEN`
environment variable.