diff --git a/docs/deployment/docker.md b/docs/deployment/docker.md index afab8ef54d..75b626e507 100644 --- a/docs/deployment/docker.md +++ b/docs/deployment/docker.md @@ -5,6 +5,10 @@ sidebar_label: Docker description: How to build a Backstage Docker image for deployment --- +:::note Note +Before you start this section, it would be good to have a basic understanding of Docker and how it works. If you are new to Docker, you can start with the [Docker overview](https://docs.docker.com/get-started/overview/) guide. +::: + 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 to its speed and more efficient and often simpler diff --git a/docs/getting-started/configure-app-with-plugins.md b/docs/getting-started/configure-app-with-plugins.md index 95fd456dc0..c31cdc0a06 100644 --- a/docs/getting-started/configure-app-with-plugins.md +++ b/docs/getting-started/configure-app-with-plugins.md @@ -4,6 +4,14 @@ title: Configuring App with plugins description: Documentation on How Configuring App with plugins --- +Audience: Developers + +:::note Note +Backstage plugins are primarily written using [TypeScript](https://www.typescriptlang.org), [Node.js](https://nodejs.org) and [React](https://reactjs.org). Having an understanding of these technologies will be beneficial on your journey to customizing Backstage! +::: + +## Summary + Backstage plugins customize the app for your needs. There is a [plugin directory](https://backstage.io/plugins) with plugins for many common infrastructure needs - CI/CD, monitoring, auditing, and more. diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index c6c96963f9..15380acc6a 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -7,6 +7,10 @@ description: How to install Backstage for your own use. Audience: Developers and Admins +:::note Note +It is not required, although recommended to have a basic understanding of [Yarn](https://www.pluralsight.com/guides/yarn-a-package-manager-for-node-js) and [npm](https://docs.npmjs.com/about-npm) before starting this guide. +::: + ## Summary This guide walks through how to get started creating your very own Backstage customizable app. This is the first step in evaluating, developing on, or demoing Backstage. @@ -21,21 +25,6 @@ If you are planning to contribute a new feature or bug fix to the Backstage proj ## Prerequisites -Before we dive in, its good to have an understanding of these concepts which are central to Backstage's -design and functionality. Being an expert in each of these concepts is not -necessary, however having a base understanding of each will make administering, developing, -configuring, and operating Backstage easier. - -- CHANGELOG - https://keepachangelog.com -- Docker - https://www.docker.com/ -- Monorepo - https://semaphoreci.com/blog/what-is-monorepo -- Node.js - https://nodejs.org -- React - https://reactjs.org -- Semantic Versioning - https://semver.org -- TypeScript - https://www.typescriptlang.org -- YAML - https://yaml.org -- Yarn - https://www.pluralsight.com/guides/yarn-a-package-manager-for-node-js - This guide also assumes a basic understanding of working on a Linux based operating system and have some experience with the terminal, specifically, these commands: `npm`, `yarn`. - Access to a Unix-based operating system, such as Linux, macOS or diff --git a/docs/getting-started/keeping-backstage-updated.md b/docs/getting-started/keeping-backstage-updated.md index 08b89db518..01e6c6ddeb 100644 --- a/docs/getting-started/keeping-backstage-updated.md +++ b/docs/getting-started/keeping-backstage-updated.md @@ -4,6 +4,14 @@ title: Keeping Backstage Updated description: How to keep your Backstage App updated --- +Audience: Developers and Admins + +:::note Note +To better understand the concepts in this section, it's recommended to have an understanding of [Monorepos](https://semaphoreci.com/blog/what-is-monorepo), [Semantic Versioning](https://semver.org) and [CHANGELOGs](https://keepachangelog.com). +::: + +## Summary + Backstage is always improving, so it's a good idea to stay in sync with the latest releases. Backstage is more of a library than an application or service; similar to `create-react-app`, the `@backstage/create-app` tool gives you a diff --git a/docs/getting-started/register-a-component.md b/docs/getting-started/register-a-component.md index c935d25807..4e2076ee8d 100644 --- a/docs/getting-started/register-a-component.md +++ b/docs/getting-started/register-a-component.md @@ -6,6 +6,10 @@ description: Start populating your Backstage app with your data. Audience: Developers +:::note Note +Entity files are stored in YAML format, if you are not familiar with YAML, you can learn more about it [here](https://yaml.org). +::: + ## Summary This guide will walk you through how to pull Backstage data from other locations manually. There are integrations that will automatically do this for you.