fix(techdocs): remove unused doc files and merge some docs into one file

This commit is contained in:
ellinors
2020-07-22 11:51:42 +02:00
parent ba13ac5978
commit ebdfadc3f9
6 changed files with 30 additions and 8 deletions
+1 -1
View File
@@ -56,7 +56,7 @@ Spotifys developer experience offering with 2,400+ documentation sites and
[concepts]: concepts.md
[reading documentation]: reading-documentation.md
[writing documentation]: writing-documentation.md
[publishing documentation]: publishing-documentation.md
[publishing documentation]: writing-and-publishing.md
[contributing]: contributing.md
[debugging]: debugging.md
[faq]: FAQ.md 'Frequently asked questions'
-1
View File
@@ -1 +0,0 @@
# Contributing
@@ -1,11 +1,21 @@
# Publishing Documentation
# Creating and publishing your docs
This section will guide you through:
- Creating a basic setup for your documentation
- Writing and previewing your documentation in a local Backstage environment
- Creating a build ready for publication
- Publishing your documentation and making your Backstage instance read from
your published docs.
## Prerequisities
- [Docker](https://docs.docker.com/get-docker/)
- Static file hosting
- A working Backstage instance with TechDocs installed
[TechDocs getting started](getting-started.md)
## Create documentation
## Create a basic documentation setup
Create a directory that contains your documentation. Inside this directory you
should create a file called `mkdocs.yml`. As an example you can create a
@@ -32,7 +42,23 @@ And then the `~/hello-docs/docs/index.md` should have the following content:
This is a basic example of documentation.
```
## Build documentation
## Writing and previewing your documentation
Using the `techdocs-cli` you can preview your docs inside a local Backstage
instance and get automatic recompilation on changes. This is useful for when you
want to write your documentation.
To do this you can run:
```bash
cd ~/hello-docs/
npx techdocs-cli serve
```
## Build production ready documentation
To get a build suitable for publication you can build your docs using the
`spotify/techdocs` container.
```bash
cd ~/hello-docs/
-1
View File
@@ -1 +0,0 @@
# Debugging
@@ -1 +0,0 @@
# Reading Documentation
@@ -1 +0,0 @@
# Writing Documentation