Skip to content

Commit 0235644

Browse files
committed
A few more edits
1 parent 6121cb4 commit 0235644

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Backstage is a platform for building developer portals, giving one view into dev
3232

3333
Its main benefit is allowing you to ship high quality code fast thanks to consistent views of your tools and infrastructure.
3434

35-
The main features you get out of the box are:
35+
The features you get out of the box are:
3636

3737
- Service catalog
3838
- Software templates
@@ -162,7 +162,7 @@ Fill out a Name and Description.
162162

163163
![Name Desc](/images/techdocs/07.png)
164164

165-
Have a GitHub org or owner and a GitHub repo ready to use for your docs. Type in the GitHub owner and the GitHub repo you want to use. Make sure there is no GitHub repo that exists with the same name or the Templater will fail.
165+
Have a GitHub org or owner and a GitHub repo ready to use for your docs. Have a [GitHub token created](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) and available in your environment as `GITHUB_TOKEN`. Type in the GitHub owner and the GitHub repo you want to use. Make sure there is no GitHub repo that exists with the same name or the Templater will fail.
166166

167167
![owner](/images/techdocs/08.png)
168168

@@ -178,20 +178,22 @@ You will be able to navigate to the docs.
178178

179179
![navigate](/images/techdocs/11.png)
180180

181-
If it is the first time you are loading them you could receive this message while it converts from MD to html.
181+
If this is the first time you are loading the docs, you could receive this message while it converts from Markdown to HTML.
182182

183183
![loading](/images/techdocs/12.png)
184184

185185
Here is a screenshot of what you will be presented with.
186186

187187
![results](/images/techdocs/13.png)
188188

189-
You now have TechDocs up and running on your machine. Well done. If you want to view the files manually they are located at the following location on your machine:
189+
You now have TechDocs up and running on your machine. Well done. If you want to view the files and work on them locally they are located at the following location on your machine:
190190

191191
```jsx
192192
backstage/node_modules/@backstage/plugin-TechDocs-backend/static/docs/default/Component/
193193
```
194194

195+
Your workflow would be to work on the files, preview locally, then commit your changes and send in pull requests, using your team's Git workflows.
196+
195197
## Publish to cloud storage
196198

197199
The recommended setup is to place the output on to cloud storage such as S3, and not on the local machine, so let's look at that.
@@ -210,7 +212,7 @@ You will also see the content in the S3 bucket.
210212

211213
## Recap and summary
212214

213-
In summary, we went through an introduction on Backstage, TechDocs, and how to publish TechDocs locally and to cloud storage via S3. If you want to learn more about Backstage I would recommend visiting [https://backstage.io](https://backstage.io) or if you want to learn more about TechDocs then [https://backstage.io/docs/features/TechDocs/TechDocs-overview](https://backstage.io/docs/features/TechDocs/TechDocs-overview) offers a great overview.
215+
In summary, we went through an introduction on Backstage, TechDocs, and how to publish TechDocs locally. We took a look at the cloud storage option with some screenshots showing S3. To learn more about Backstage I would recommend visiting [https://backstage.io](https://backstage.io) or if you want to learn more about TechDocs then [https://backstage.io/docs/features/TechDocs/TechDocs-overview](https://backstage.io/docs/features/TechDocs/TechDocs-overview) offers a great overview.
214216

215217
You can also read about the gains the team at Spotify has seen since using TechDocs for all their documentation in [Ten tips for maintaining a long-term relationship with docs like code](https://www.docslikecode.com/articles/ten-tips-maintaining-long-term-docs-like-code/).
216218

0 commit comments

Comments
 (0)