diff --git a/docs/deployment/docker.md b/docs/deployment/docker.md index 2133919770..ef178b2977 100644 --- a/docs/deployment/docker.md +++ b/docs/deployment/docker.md @@ -9,7 +9,7 @@ This section describes how to build a Backstage App into a deployable Docker image. It is split into three sections, first covering the host build approach, which is recommended due its speed and more efficient and often simpler caching. The second section covers a full multi-stage Docker build, and the last section -covers how deploy the frontend and backend as separate images. +covers how to deploy the frontend and backend as separate images. Something that goes for all of these docker deployment strategies is that they are stateless, so for a production deployment you will want to set up and diff --git a/docs/deployment/k8s.md b/docs/deployment/k8s.md index 2b3386ef7c..9dbf447740 100644 --- a/docs/deployment/k8s.md +++ b/docs/deployment/k8s.md @@ -17,7 +17,7 @@ This guide covers basic Kubernetes definitions needed to get Backstage up and running in a typical cluster. The object definitions might look familiar, since the Backstage software catalog [also uses](../features/software-catalog/descriptor-format.md) the Kubernetes -object format! +object format for its entity definition files! ## Testing locally @@ -84,7 +84,7 @@ for PostgreSQL. ### Creating a PostgreSQL secret First, create a Kubernetes Secret for the PostgreSQL username and password. This -will be used by both the PostgreSQL and Backstage deployments: +will be used by both the PostgreSQL database and Backstage deployments: ```yaml # kubernetes/postgres-secrets.yaml @@ -158,7 +158,7 @@ spec: storage: 2G ``` -This file contains definitions for two different kinds, separate by a line with +This file contains definitions for two different kinds, separated by a line with a triple dash. This syntax is helpful if you want to consolidate related Kubernetes definitions in a single file and apply them at the same time.