docs(scaffolder) tidy up some more docs (#1661)

* docs(scaffolder): Added some reference for the Template kind in the service catalog

* docs(scaffolder): adding a basic readme for the scaffolder

* docs(scaffolder): more small fixes

* chore(scaffolder): removing unused routes in the scaffolder

* docs(scaffolder): fixing linking to the template entity

* docs(scaffolder): fixing indentation

* docs(scaffolder): rewrite a little

* chore(scaffolder): Added some more documentation sections

* docs(scaffolder): added some documentation about loading your own templates

* docs(scaffolder): created some great documentation. make docs great again

* docs(scaffolder): added some more info about creating your own templater

* chore(scaffolder): finshing of create your own templater docs

* docs(scaffolder): updating the last of the preparr

* docs(scaffolder): think docs are great for scaffolder again

* docs(scaffolder): more user docs for the scaffolder

* docs(scaffolder): fix header

* docs(scaffolder): shuffle around the documenation

* chore(scaffolder): fixing again

* docs(scaffolder): fixing some docs again
This commit is contained in:
Ben Lambert
2020-07-16 07:25:18 +02:00
committed by GitHub
parent c4986e7922
commit 0ea6125479
5 changed files with 10 additions and 7 deletions
+5 -1
View File
@@ -32,8 +32,12 @@ better yet, a pull request.
- [API](features/software-catalog/api.md)
- Software creation templates
- [Overview](features/software-templates/index.md)
- [Configure templates](features/software-templates/configure-templates.md)
- [Adding templates](features/software-templates/adding-templates.md)
- Extending the Scaffolder:
- [Overview](features/software-templates/extending/index.md)
- [Create your own Templater](features/software-templates/extending/create-your-own-templater.md)
- [Create your own Publisher](features/software-templates/extending/create-your-own-publisher.md)
- [Create your own Preparer](features/software-templates/extending/create-your-own-preparer.md)
- Docs-like-code
- [Overview](features/techdocs/README.md)
- [Getting Started](features/techdocs/getting-started.md)
@@ -312,7 +312,7 @@ Apart from being a string, the software catalog leaves the format of this field
open to implementers to choose. Most commonly, it is set to the ID or email of a
group of people in an organizational structure.
##
## Kind: Template
Describes the following entity kind:
@@ -43,7 +43,7 @@ As you can see in the above code a `TemplaterBuilder` is created and the default
This `TemplaterKey` is used to select the correct templater from the
`spec.templater` in the
[Template Entity](../software-catalog/descriptor-format.md#kind-template).
[Template Entity](../../software-catalog/descriptor-format.md#kind-template).
If you wish to add a new templater you'll need to register it with the
`TemplaterBuilder`.
@@ -73,9 +73,9 @@ follows:
- `directory`- the skeleton directory returned from the `Preparer`, more info at
[Create your own preparer](./create-your-own-preparer.md).
- `values` - a json object which will resemble the `spec.schema` from the
[Template Entity](../software-catalog/descriptor-format.md#kind-template)
[Template Entity](../../software-catalog/descriptor-format.md#kind-template)
which is defined here under spec.schema`. More info can be found here
[Register your own template](./register-your-own-template.md#adding-form-values-in-the-scaffolder-wizard)
[Register your own template](../adding-templates.md#adding-form-values-in-the-scaffolder-wizard)
- `logStream` - a stream that you can write to for displaying in the frontend.
- `dockerClient` - a [dockerode](https://github.com/apocas/dockerode) client to
be able to run docker containers.
+1 -1
View File
@@ -29,7 +29,7 @@ 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-1.png)
![Enter backstage vars](./assets/template-picked-2.png)
### Run!
-1
View File
@@ -30,7 +30,6 @@ nav:
- API: 'features/software-catalog/api.md'
- Software creation templates:
- Overview: 'features/software-templates/index.md'
- Configure templates: 'features/software-templates/configure-templates.md'
- Adding templates: 'features/software-templates/adding-templates.md'
- Extending the Scaffolder:
- Overview: 'features/software-templates/extending/index.md'