You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _posts/articles/2021-02-14-setting-up-techdocs-on-backstage.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ share: true
14
14
---
15
15
TechDocs is Spotify’s homegrown docs-like-code solution built directly into Backstage. [Backstage](https://github.com/backstage/backstage) gives teams one front-end view for all their infrastructure tools, like Google Cloud Platform, Cloud Bigtable, CI pipelines, TensorFlow Extended, and others, all in a consistent, easy-to-use interface, or portal. It's open source software released by Spotify.
16
16
17
-
With TechDocs built into Backstage, all the engineers write their documentation in Markdown files which live together with their code. In this post we will walk you through how to setup Backstage and Techdocs.
17
+
With TechDocs built into Backstage, all the engineers write their documentation in Markdown files which live together with their code. You can read more about their docs-as-code story in [this article](https://www.docslikecode.com/articles/ten-tips-maintaining-long-term-docs-like-code/). In this post we will walk you through how to setup Backstage and Techdocs.
18
18
19
19
**Table of contents**
20
20
@@ -39,13 +39,13 @@ The features you get out of the box are:
39
39
- Plugins which allow you to extend Backstage functionality
40
40
- TechDocs, which is the focus of this post
41
41
42
-
These features allow you to create standards and best practices across teams. It increases the speed of development. It creates a good developer experience for everyone who uses it. You centralise all your tools and information in one place.
42
+
These features allow you to create standards and best practices across teams. It increases the speed of development. It creates a good developer experience for everyone who uses it. You centralize all your tools and information in one place.
43
43
44
44
In this post I will take you through the basic concepts and structure of Backstage and TechDocs, an installation of Backstage including the setup of TechDocs, creating and publishing documentation, all on a local machine on MacOS.
45
45
46
-
## Basics concepts and structures of backstage and TechDocs
46
+
## Basic concepts and structures of Backstage and TechDocs
47
47
48
-
The focus of this article is TechDocs, so I will go through the other main features at a high level.
48
+
The focus of this article is TechDocs, so I will go through the main features at a high level.
49
49
50
50
- Service catalog - It keeps track of ownership and metadata for all the software in your ecosystem. Backstage does this by putting metadata in YAML files stored together with your code. You process these files and then you can visualise the catalog in Backstage. This catalog enables your teams to manage and maintain the software they own, making the software discoverable.
51
51
- Software templates - This feature allows you to create templates or skeletons of code. These templates are published to GitHub.
@@ -78,7 +78,7 @@ For the following instructions, since we are using a local install for demonstra
78
78
79
79
## Install Backstage
80
80
81
-
### Prequisites
81
+
### Prerequisites
82
82
83
83
* Mac running MacOS
84
84
@@ -100,11 +100,11 @@ You are asked some questions on setup. The recommendation for this local tutoria
100
100
101
101

102
102
103
-
If successful you will see this message:
103
+
If successful you see this message:
104
104
105
105

106
106
107
-
Change into your created app's directory, the name you used for the app, in this example it's`infraportal`:
107
+
Change into your created app's directory, the name you used for the app. In this example the name is`infraportal`:
108
108
109
109
```
110
110
cd infraportal
@@ -133,13 +133,13 @@ yarn run start
133
133
134
134
If successful, a browser window opens and you should be presented with a window.
135
135
136
-

136
+

137
137
138
138
Well done, you have successfully installed Backstage on your local machine.
139
139
140
140
## Setup TechDocs
141
141
142
-
Historically you had to manually add Techdocs, but now the latest version of create-app bundles TechDocs.
142
+
Historically you had to manually add Techdocs, but now the latest version of `create-app` bundles TechDocs.
143
143
144
144
To verify this setup, you should be able to see entries for the plugin `'@backstage/plugin-TechDocs';` in the following files:
145
145
@@ -150,7 +150,7 @@ packages/app/src/App.tsx
150
150
151
151
## Creating and publishing TechDocs
152
152
153
-
To create docs manually from scratch, click on create component:
153
+
To create docs manually from scratch, click on Create component:
154
154
155
155

156
156
@@ -170,7 +170,7 @@ Once you click on create you will be presented with a Create component status po
170
170
171
171

172
172
173
-
Once the repository has been published to GitHub, the create component status popup will show green like below.
173
+
Once the repository has been published to GitHub, the Create component status popup will show green like below.
0 commit comments