Commit Graph

12 Commits

Author SHA1 Message Date
Stefan Ålund ec13744b36 Document the service catalog (#1922) 2020-08-12 16:14:45 +02:00
Patrik Oldsberg b25ffdc958 docs: added configuration docs (#1863)
* docs: added configuration docs

* docs: add all config pages to ToCs
2020-08-09 22:34:04 +02:00
David Tuite 7db913e36b Add api-catalog.yaml file (#1822)
Also added ARD008 to explain the decision. This is linked from
`mkdocs.yaml` and `docs/README.md`.

Co-authored-by: David Tuite <dtuite@gmail.com>
2020-08-05 14:43:06 +02:00
Marcus Eide abd953abbe Merge pull request #1630 from spotify/blam/msw-adr
docs(adr): Created an ADR for MSW
2020-07-27 15:17:27 +02:00
David Tuite ac5a6050aa Write architecture overview (#1685)
This covers the frontend, backend, different plugin designs and
containerization.

Further work should cover authentication.

Co-authored-by: David Tuite <dtuite@gmail.com>
2020-07-22 00:23:46 +02:00
Stefan Ålund ce30c43d24 [Docs] Fix relative paths to code (#1662)
* [Docs] Fix relative paths to code

* Update create-a-plugin.md

* Link to existing plugins

* Update README.md

* Update README.md

* Review edits
2020-07-16 09:17:43 +02:00
Ben Lambert 0ea6125479 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
2020-07-16 07:25:18 +02:00
Stefan Ålund a3449939b0 [Docs] Fix links in main README (#1651) 2020-07-15 17:50:09 +02:00
Ben Lambert a14dae9b10 Scaffolder Documentation (#1616)
* 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

* chore(scaffolder): fixing issue with publisher base mistyping

* docs(scaffolder): creating some how to use documentation

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

* docs(scaffolder): fix header

* docs(scaffolder): fixing

* docs(scaffolder): shuffle around the documenation
2020-07-15 16:32:44 +02:00
Stefan Ålund f59dd3a073 [Docs] Fix broken links and more 2020-07-15 12:24:15 +02:00
blam 191aa0262f chore(docs): add to doc structure 2020-07-15 10:02:49 +02:00
Stefan Ålund 8ec6ed5170 Documentation skeleton (#1617)
* Documentation skeleton

* Added ADR list and more

* rm material theme

* Update mkdocs.yml

* Add docs TOC

* Work for plain MD and mkdocs

* Update mkdocs.yml

* Restructuring

* Added roadmap

* Add reference APIs

* move publishing
2020-07-15 08:57:25 +02:00