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
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Backstage is a platform for building developer portals, giving one view into dev
32
32
33
33
Its main benefit is allowing you to ship high quality code fast thanks to consistent views of your tools and infrastructure.
34
34
35
-
The main features you get out of the box are:
35
+
The features you get out of the box are:
36
36
37
37
- Service catalog
38
38
- Software templates
@@ -162,7 +162,7 @@ Fill out a Name and Description.
162
162
163
163

164
164
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.
166
166
167
167

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

180
180
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.
182
182
183
183

184
184
185
185
Here is a screenshot of what you will be presented with.
186
186
187
187

188
188
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:
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
+
195
197
## Publish to cloud storage
196
198
197
199
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.
210
212
211
213
## Recap and summary
212
214
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.
214
216
215
217
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/).
0 commit comments