Commit Graph

179 Commits

Author SHA1 Message Date
Ivan Shmidt 3c8976e44c fix: conflicts 2020-08-12 11:12:22 +02:00
Emma Indal 7529211cc0 fix(roadmap): switch links to milestones for v2 and v3 2020-08-11 20:07:17 +02:00
Emma Indal 38737c9e73 fix(roadmap): adjust project roadmap and link to use cases for v2 2020-08-11 20:04:09 +02:00
Sebastian Qvarfordt b0032f9739 Added v2 to techdocs readme 2020-08-11 18:47:34 +02:00
Patrik Oldsberg f4c0af1c16 Merge pull request #1906 from spotify/rugvip/doc-urls
Verify and fix broken urls in documentation
2020-08-11 17:14:41 +02:00
Ivan Shmidt 45ba08a1d5 docs: start bringing structure from /docs to docusaurus 2020-08-11 15:32:23 +02:00
Stefan Ålund 934c8291bb Update README with new copy (#1900) 2020-08-11 15:15:06 +02:00
Patrik Oldsberg f69a2804ae docs: fix broken links 2020-08-11 12:21:15 +02:00
Patrik Oldsberg 7763657a17 docs: add basic script to verify local documentation links 2020-08-11 12:20:32 +02:00
Kat Zhou 4b0a4af3e5 Update design.md (#1898) 2020-08-11 11:45:52 +02:00
Mijail Rondón cae4aeb93e Fix create-an-app.md output image (#1897)
The image src url is broken.
2020-08-11 10:24:13 +02:00
Chris Simmons 1c559bcc90 Enable override of sidebar selected indicator color when using createTheme (#1880)
* refactored sidebar palette types + updated default themes

* use @backstage/theme and new selectedIndicatorColor palette property

* fixed sidebar to use refactored backgroundColor property

* simplified property names based on feedback

* renamed sidebar to navigation in palette

* updated AppThemeApi docs with PaletteAdditions changes
2020-08-11 08:16:46 +02:00
Ben Lambert 9e0098ee3e Remove extraneous tab 2020-08-10 22:04:53 +02:00
Patrik Oldsberg aab8058136 Merge pull request #1871 from spotify/rugvip/can-has-config
config: added config.has() and allow config.get() to be called with no args
2020-08-10 18:35:27 +02:00
Emma Indal 7462a1d5a1 fixup 2020-08-10 14:29:59 +02:00
Emma Indal 96bc61aeb2 Add use cases connected to TechDocs versions in project roadmap 2020-08-10 14:25:26 +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
Patrik Oldsberg b5b976270d docs: regenerated utility api reference docs 2020-08-08 12:09:00 +02:00
Fredrik Adelöw 40f5fef542 Merge pull request #1828 from spotify/blam/fix-somedox
chore(scaffolder): remove bad formatting in docs
2020-08-06 15:19:48 +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
Ben Lambert a93fd63cb7 Update adding-templates.md 2020-08-05 03:14:28 +02:00
Patrik Oldsberg bd3d0de77f Merge pull request #1745 from ayshiff/refactor/cli-create-app
Refactor: Move @backstage/cli create-app to separate package
2020-08-02 22:37:43 +02:00
Bodil Björklund 0fe2ddf70f Tweaks to techdocs docs
Text editing
2020-07-30 17:04:03 +02:00
Rémi DOREAU 489a57b0c7 feat(create-app): requested changes 2020-07-30 01:09:43 +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
Patrik Oldsberg ee2f6f1218 Merge branch 'master' into rugvip/docgen 2020-07-27 12:56:42 +02:00
blam 3aaf4f0200 chore(adr): added adr reference to techocs 2020-07-27 12:52:11 +02:00
Patrik Oldsberg 13b62f2aff app: make bundling a regular build command 2020-07-26 20:33:59 +02:00
ellinors fb3284a35b fix(techdocs): clean up unused links 2020-07-22 11:55:16 +02:00
ellinors 12f4979cdf fix(techdocs): updated link in techdocs README.md to point to new file 2020-07-22 11:53:06 +02:00
ellinors ebdfadc3f9 fix(techdocs): remove unused doc files and merge some docs into one file 2020-07-22 11:51:42 +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
ellieseastream 5c61ec0ed5 Merge pull request #1703 from spotify/emmai/techdocs-docs-concepts
Techdocs: concept documentation
2020-07-21 17:05:03 +02:00
ellinors 6404144d13 fix(techdocs): updated concepts documentation. 2020-07-21 17:02:22 +02:00
Emma Indal 4f5ed073f3 fix(techdocs-docs-concepts): TechDocs concept documentation 2020-07-21 15:02:36 +02:00
Emma Indal a6b33a0faf wip 2020-07-21 11:00:35 +02:00
Emma Indal 6406d8f863 fix(techdocs-faq-docs): Add section to FAQ 2020-07-21 08:34:06 +02:00
Patrik Oldsberg c75beb460d docs: regenerate api reference docs 2020-07-19 14:27:36 +02:00
Patrik Oldsberg 3dd7fa7c3e docs: add links to api references 2020-07-19 14:27:35 +02:00
Patrik Oldsberg 8cd5fb5e7c docs: generate utility api reference 2020-07-19 14:27:34 +02:00
Oliver Sand 183179669f docs: Add link to Figma library (#1674) 2020-07-17 17:42:40 +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
ellieseastream 8a949c3f3d Merge pull request #1650 from spotify/mob/techdocs-publishing-documentation
TechDocs: Updated documentation on publishing-documentation.md
2020-07-15 16:42:23 +02:00
ellieseastream 59573f2755 Merge pull request #1620 from spotify/mob/techdocs-getting-started-docs
[TechDocs]: added content to getting started with techdocs as a p…
2020-07-15 16:41:33 +02:00
ellinors 38e9eb419a docs(techdocs): Updated documentation on how to publish documentation in TechDocs. 2020-07-15 16:36:05 +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
Ben Lambert a6e1bafab8 Merge pull request #1633 from spotify/blam/docker-compose
Simple docker-compose and docs reshuffle
2020-07-15 16:03:54 +02:00
Stefan Ålund 20f030ab87 [Docs] Fixed some more links (#1648) 2020-07-15 15:59:34 +02:00