diff --git a/docs/getting-started/configure-app-with-plugins.md b/docs/getting-started/configure-app-with-plugins.md index 64b9e772d1..af7fdbb4cb 100644 --- a/docs/getting-started/configure-app-with-plugins.md +++ b/docs/getting-started/configure-app-with-plugins.md @@ -4,17 +4,22 @@ title: Configuring App with plugins description: Documentation on How Configuring App with plugins --- +Backstage plugins customize the app for your needs. There is a +[plugin marketplace](https://backstage.io/plugins) with plugins for many common +infrastructure needs - CI/CD, monitoring, auditing, and more. + ## Adding existing plugins to your app -The following steps assume that you have created a new Backstage app and want to -add an existing plugin to it. We are using the +The following steps assume that you have +[created a Backstage app](./create-an-app.md) and want to add an existing plugin +to it. We are using the [CircleCI](https://github.com/backstage/backstage/blob/master/plugins/circleci/README.md) plugin in this example. 1. Add the plugin's npm package to the repo: ```bash -yarn add @backstage/plugin-circleci +yarn workspace app add @backstage/plugin-circleci ``` 2. Add the plugin itself: diff --git a/docs/getting-started/deployment-docker.md b/docs/getting-started/deployment-docker.md index 69158f9104..37a48f5457 100644 --- a/docs/getting-started/deployment-docker.md +++ b/docs/getting-started/deployment-docker.md @@ -27,9 +27,9 @@ The required steps in the host build are to install dependencies with `yarn install`, generate type definitions using `yarn tsc`, and build all packages with `yarn build`. -> NOTE: Using `yarn build` to build packages and bundle the backend assumes that -> you have migrated to using `backstage-cli backend:bundle` as your build script -> in the backend package. +> NOTE: If you created your app prior to 2021-02-18, follow the +> [migration step](https://github.com/backstage/backstage/releases/tag/release-2021-02-18) +> to move from `backend:build` to `backend:bundle`. In a CI workflow it might look something like this: @@ -43,22 +43,10 @@ yarn tsc yarn build ``` -Once the host build is complete, we are ready to build our image. We use the -following `Dockerfile`, which is also included when creating a new app with -`@backstage/create-app`: +Once the host build is complete, we are ready to build our image. The following +`Dockerfile` is included when creating a new app with `@backstage/create-app`: ```Dockerfile -# This dockerfile builds an image for the backend package. -# It should be executed with the root of the repo as docker context. -# -# Before building this image, be sure to have run the following commands in the repo root: -# -# yarn install -# yarn tsc -# yarn build -# -# Once the commands have been run, you can build the image using `yarn build-image` - FROM node:14-buster-slim WORKDIR /app @@ -78,15 +66,15 @@ CMD ["node", "packages/backend", "--config", "app-config.yaml"] For more details on how the `backend:bundle` command and the `skeleton.tar.gz` file works, see the -[`backend:bundle` command docs](../cli/commands.md#backendbundle) +[`backend:bundle` command docs](../cli/commands.md#backendbundle). -The `Dockerfile` is typically placed at `packages/backend/Dockerfile`, but needs -to be executed with the root of the repo as the build context, in order to get -access to the root `yarn.lock` and `package.json`, along with any other files -that might be needed, such as `.npmrc`. +The `Dockerfile` is located at `packages/backend/Dockerfile`, but needs to be +executed with the root of the repo as the build context, in order to get access +to the root `yarn.lock` and `package.json`, along with any other files that +might be needed, such as `.npmrc`. -In order to speed up the build we can significantly reduce the build context -size using the following `.dockerignore` in the root of the repo: +The `@backstage/create-app` command adds the following `.dockerignore` in the +root of the repo to speed up the build by reducing build context size: ```text .git @@ -96,9 +84,9 @@ packages plugins ``` -With the project build and the `.dockerignore` and `Dockerfile` in place, we are -now ready to build the final image. Assuming we're at the root of the repo, we -execute the build like this: +With the project built and the `.dockerignore` and `Dockerfile` in place, we are +now ready to build the final image. From the root of the repo, execute the +build: ```bash docker image build . -f packages/backend/Dockerfile --tag backstage diff --git a/packages/create-app/templates/default-app/packages/app/package.json.hbs b/packages/create-app/templates/default-app/packages/app/package.json.hbs index c7561fe091..d42e19eb1f 100644 --- a/packages/create-app/templates/default-app/packages/app/package.json.hbs +++ b/packages/create-app/templates/default-app/packages/app/package.json.hbs @@ -15,7 +15,6 @@ "@backstage/plugin-scaffolder": "^{{version '@backstage/plugin-scaffolder'}}", "@backstage/plugin-techdocs": "^{{version '@backstage/plugin-techdocs'}}", "@backstage/catalog-model": "^{{version '@backstage/catalog-model'}}", - "@backstage/plugin-circleci": "^{{version '@backstage/plugin-circleci'}}", "@backstage/plugin-tech-radar": "^{{version '@backstage/plugin-tech-radar'}}", "@backstage/plugin-github-actions": "^{{version '@backstage/plugin-github-actions'}}", "@backstage/plugin-user-settings": "^{{version '@backstage/plugin-user-settings'}}", diff --git a/packages/create-app/templates/default-app/packages/app/src/components/catalog/EntityPage.tsx b/packages/create-app/templates/default-app/packages/app/src/components/catalog/EntityPage.tsx index a3a3715ab0..de6ab2b6b5 100644 --- a/packages/create-app/templates/default-app/packages/app/src/components/catalog/EntityPage.tsx +++ b/packages/create-app/templates/default-app/packages/app/src/components/catalog/EntityPage.tsx @@ -17,9 +17,9 @@ import { ApiEntity, Entity } from '@backstage/catalog-model'; import { WarningPanel } from '@backstage/core'; import { ApiDefinitionCard, - ConsumedApisCard, - ConsumingComponentsCard, - ProvidedApisCard, + ConsumedApisCard, + ConsumingComponentsCard, + ProvidedApisCard, ProvidingComponentsCard } from '@backstage/plugin-api-docs'; import { @@ -28,9 +28,6 @@ import { import { useEntity } from '@backstage/plugin-catalog-react'; -import { - isPluginApplicableToEntity as isCircleCIAvailable, Router as CircleCIRouter -} from '@backstage/plugin-circleci'; import { isPluginApplicableToEntity as isGitHubActionsAvailable, Router as GitHubActionsRouter } from '@backstage/plugin-github-actions'; @@ -45,8 +42,6 @@ const CICDSwitcher = ({ entity }: { entity: Entity }) => { switch (true) { case isGitHubActionsAvailable(entity): return ; - case isCircleCIAvailable(entity): - return ; default: return ( diff --git a/packages/create-app/templates/default-app/packages/app/src/plugins.ts b/packages/create-app/templates/default-app/packages/app/src/plugins.ts index 28b42d5be2..df53885723 100644 --- a/packages/create-app/templates/default-app/packages/app/src/plugins.ts +++ b/packages/create-app/templates/default-app/packages/app/src/plugins.ts @@ -1,7 +1,6 @@ export { plugin as ApiDocs } from '@backstage/plugin-api-docs'; export { plugin as CatalogPlugin } from '@backstage/plugin-catalog'; export { plugin as CatalogImport } from '@backstage/plugin-catalog-import'; -export { plugin as Circleci } from '@backstage/plugin-circleci'; export { plugin as GithubActions } from '@backstage/plugin-github-actions'; export { plugin as ScaffolderPlugin } from '@backstage/plugin-scaffolder'; export { plugin as TechDocsPlugin } from '@backstage/plugin-techdocs';