From 63d1bd80cc3c5095086d2045c7e21ee970432206 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 12 Aug 2020 10:27:25 +0200 Subject: [PATCH] docs/features/software-templates: review fixes Co-authored-by: Ben Lambert --- docs/features/software-catalog/descriptor-format.md | 8 ++++---- docs/features/software-templates/installation.md | 9 +++++++++ 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 31b5e59fc6..0e29453097 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -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 diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index 36dc5ebb14..ee66fc654c 100644 --- a/docs/features/software-templates/installation.md +++ b/docs/features/software-templates/installation.md @@ -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.