feat: the whole docs structure

Co-authored-by: Raghunandan Balachandran <meetraghu28@gmail.com> Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 15:20:20 +02:00
parent 0867d3dc30
commit 882728ae1d
67 changed files with 352 additions and 179 deletions
@@ -84,7 +84,7 @@ The root envelope object has the following structure.
 ### `apiVersion` and `kind` [required]

 The `kind` is the high level entity type being described.
-[ADR005](/docs/architecture-decisions/adr005-catalog-core-entities.md) describes
+[ADR005](../../architecture-decisions/adr005-catalog-core-entities.md) describes
 a number of core kinds that plugins can know of and understand, but an
 organization using Backstage is free to also add entities of other kinds to the
 catalog.
@@ -2,3 +2,5 @@
 id: extending-the-model
 title: Extending the model
 ---
+
+TODO
@@ -2,3 +2,5 @@
 id: external-integrations
 title: External integrations
 ---
+
+TODO
@@ -26,7 +26,7 @@ can be organised around the entities in the catalog.

 TODO

-![](service-catalog-home.png)
+![](../../assets/software-catalog/service-catalog-home.png)

 ## Links

@@ -2,3 +2,5 @@
 id: system-model
 title: System Model
 ---
+
+TODO
@@ -1,7 +1,6 @@
 ---
 id: extending-index
 title: Extending the Scaffolder
-sidebar_label: Overview
 ---

 Welcome. Take a seat. You're at the Scaffolder Documentation.
@@ -16,7 +16,7 @@ reach `http://localhost:3000/create`.

 You should get something that looks similar to this:

-![Create Image](./assets/create.png)
+![Create Image](../../assets/software-templates/create.png)

 ### Choose a template

@@ -25,38 +25,38 @@ page which may or may not look different for each template. Each template can
 ask for different input variables, and they are then passed to the templater
 internally.

-![Enter some variables](./assets/template-picked.png)
+![Enter some variables](../../assets/software-templates/template-picked.png)

 After filling in these variables, you'll get some more fields to fill out which
 are required for backstage usage. The owner, which is a `user` in the backstage
 system, and the `storePath` which right now must be a Github Organisation and a
 non-existing github repository name in the format `organistaion/reponame`.

-![Enter backstage vars](./assets/template-picked-2.png)
+![Enter backstage vars](../../assets/software-templates/template-picked-2.png)

 ### Run!

 Once you've entered values and confirmed, you'll then get a modal with live
 progress of what is currently happening with the creation of your template.

-![Templating Running](./assets/running.png)
+![Templating Running](../../assets/software-templates/running.png)

 It shouldn't take too long, and you'll have a success screen!

-![Templating Complete](./assets/complete.png)
+![Templating Complete](../../assets/software-templates/complete.png)

 If it fails, you'll be able to click on each section to get the log from the
 step that failed which can be helpful to debug.

-![Templating failed](./assets/failed.png)
+![Templating failed](../../assets/software-templates/failed.png)

 ### View Component in Catalog

 When it's been created you'll see the `View in Catalog` button, which will take
 you to the registered component in the catalog:

-![Catalog](./assets/go-to-catalog.png)
+![Catalog](../../assets/software-templates/go-to-catalog.png)

 And then you'll also be able to see it in the Catalog View table

-![Catalog](./assets/added-to-the-catalog-list.png)
+![Catalog](../../assets/software-templates/added-to-the-catalog-list.png)
@@ -12,7 +12,7 @@ The TechDocs Core Plugin is a MkDocs plugin created as a wrapper around multiple
 MkDocs plugins and Python Markdown extensions to standardize the configuration
 of MkDocs used for TechDocs.

-[TechDocs Core](../../../packages/techdocs-container/techdocs-core/README.md)
+[TechDocs Core](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/techdocs-core/README.md)

 ### TechDocs container

@@ -21,7 +21,7 @@ The TechDocs container is a Docker container available at
 pages, including stylesheets and scripts from Python flavored Markdown, through
 MkDocs.

-[TechDocs Container](../../../packages/techdocs-container/README.md)
+[TechDocs Container](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/README.md)

 ### TechDocs publisher (coming soon)

@@ -32,7 +32,7 @@ documentation for publishing. Currently it mostly acts as a wrapper around the
 TechDocs container and provides an easy-to-use interface for our docker
 container.

-[TechDocs CLI](../../../packages/techdocs-cli/README.md)
+[TechDocs CLI](https://github.com/spotify/backstage/blob/master/packages/techdocs-cli/README.md)

 ### TechDocs Reader

@@ -44,7 +44,7 @@ The TechDocs Reader purpose is also to open up the opportunity to integrate
 TechDocs widgets for a customized full-featured TechDocs experience.
 ([coming soon V.2](https://github.com/spotify/backstage/milestone/17))

-[TechDocs Reader](../../../plugins/techdocs/src/reader/README.md)
+[TechDocs Reader](https://github.com/spotify/backstage/blob/master/plugins/techdocs/src/reader/README.md)

 ### Transformers

@@ -53,4 +53,4 @@ Reader. The reason why transformers were introduced was to provide a way to
 transform the HTML content on pre and post render (e.g. rewrite docs links or
 modify css).

-[Transformers API docs](../../../plugins/techdocs/src/reader/transformers/README.md)
+[Transformers API docs](https://github.com/spotify/backstage/blob/master/plugins/techdocs/src/reader/transformers/README.md)