Skip to content

Commit 208df27

Browse files
committed
Add link to Ten tips to maintaining long term docs like code
1 parent da37b4d commit 208df27

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

_posts/articles/2021-02-14-setting-up-techdocs-on-backstage.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ share: true
1414
---
1515
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.
1616

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.
1818

1919
**Table of contents**
2020

@@ -39,13 +39,13 @@ The features you get out of the box are:
3939
- Plugins which allow you to extend Backstage functionality
4040
- TechDocs, which is the focus of this post
4141

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.
4343

4444
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.
4545

46-
## Basics concepts and structures of backstage and TechDocs
46+
## Basic concepts and structures of Backstage and TechDocs
4747

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.
4949

5050
- 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.
5151
- 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
7878

7979
## Install Backstage
8080

81-
### Prequisites
81+
### Prerequisites
8282

8383
* Mac running MacOS
8484

@@ -100,11 +100,11 @@ You are asked some questions on setup. The recommendation for this local tutoria
100100

101101
![npx install](/images/techdocs/create-app.png)
102102

103-
If successful you will see this message:
103+
If successful you see this message:
104104

105105
![successful](/images/techdocs/01.png)
106106

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`:
108108

109109
```
110110
cd infraportal
@@ -133,13 +133,13 @@ yarn run start
133133

134134
If successful, a browser window opens and you should be presented with a window.
135135

136-
![successfull register](/images/techdocs/04.png)
136+
![successful register](/images/techdocs/04.png)
137137

138138
Well done, you have successfully installed Backstage on your local machine.
139139

140140
## Setup TechDocs
141141

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.
143143

144144
To verify this setup, you should be able to see entries for the plugin `'@backstage/plugin-TechDocs';` in the following files:
145145

@@ -150,7 +150,7 @@ packages/app/src/App.tsx
150150

151151
## Creating and publishing TechDocs
152152

153-
To create docs manually from scratch, click on create component:
153+
To create docs manually from scratch, click on Create component:
154154

155155
![manuall](/images/techdocs/05.png)
156156

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

171171
![create component](/images/techdocs/09.png)
172172

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.
174174

175175
![popup](/images/techdocs/10.png)
176176

0 commit comments

Comments
 (0)