Commit Graph

42 Commits

Author SHA1 Message Date
blam 6cd4a99261 chore: update documentation around ADR and the template skeleton 2021-01-09 23:18:14 +01:00
blam 47814df6f4 chore: remove superfluous comment 2021-01-09 23:14:40 +01:00
blam 38c2f1be56 chore: add sample preamble 2021-01-09 23:13:49 +01:00
blam 3254b55617 chore: fixing code review comments to align with better numbers 2021-01-09 23:00:05 +01:00
blam 3a03a4100a chore: actually add the adr template which appears to have gone missing in the repo 2021-01-09 19:54:44 +01:00
Frieder Bluemle cbd3a44c09 Fix typos (#3646) 2020-12-09 07:50:41 +01:00
Patrik Oldsberg af141c0766 rewrite repo location urls 2020-11-03 11:03:49 +01:00
Stefan Ålund 04f939e370 Update adr006-avoid-react-fc.md (#2649)
* Update adr006-avoid-react-fc.md

* Update adr006-avoid-react-fc.md
2020-09-29 09:47:06 +02:00
Navaneeth Suresh e7686833fd docs: fix typos in the documentation (#2633) 2020-09-28 13:18:40 +02:00
Mayurs 17c30eaf3e fix(docs): Fix typos in several .md files (#2627) 2020-09-27 18:57:20 +02:00
Fredrik Adelöw 0222279021 feat(freben): add handling and docs for entity references 2020-09-22 15:27:13 +02:00
Oliver Sand 232f0538df docs: improve navigation around ADRs 2020-09-17 13:01:25 +02:00
Rajiv Ranjan Singh 812da7539f added description header field 2020-09-16 21:56:32 +05:30
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Eduardo Ramírez caa58002aa minor typo 2020-09-09 11:40:00 +02:00
Ivan Shmidt 5b3ad2a284 feat(circleci): export router 2020-09-04 15:57:31 +02:00
Stefan Ålund a8edb19f61 [Docs] Various fixes (#2136)
* [Docs] Various fixes

* More fixes

* Fix ADRs

* Typo
2020-08-27 13:27:22 +02:00
Ivan Shmidt 882728ae1d 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
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
blam fba8eb9cdc Merge branch 'master' of github.com:spotify/backstage into blam/msw-adr
* 'master' of github.com:spotify/backstage:
  Documentation skeleton (#1617)
  [TechDocs] Use Backstage docs as example (#1625)
2020-07-15 09:52:57 +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
blam c1e2a8dcc5 docs(adr): Created an ADR for MSW 2020-07-14 21:16:00 +02:00
Ivan Shmidt 8f1e0f67d1 Merge branch 'master' of github.com:spotify/backstage into shmidt-i/scaffolder-flow-frontend 2020-07-06 13:53:45 +02:00
ellieseastream cec455c0e4 Update adr006-avoid-react-fc.md 2020-07-01 17:30:28 +02:00
ellieseastream 4491e52567 Update adr006-avoid-react-fc.md 2020-07-01 16:22:04 +02:00
ellieseastream b6ec4298bc Added PR link and edited example. 2020-07-01 16:21:07 +02:00
ellieseastream b926b4ef7b Added example of changing existing React.FC code 2020-06-30 17:08:39 +02:00
ellieseastream 9f475bacd3 Rename adr006-avoid-react-fc to adr006-avoid-react-fc.md 2020-06-30 16:10:57 +02:00
ellieseastream c5bdbdfe85 Create adr006-avoid-react-fc 2020-06-30 16:08:15 +02:00
Fredrik Adelöw 7d8c50bdac Remove remaining occurrences of v1beta1 2020-06-16 13:28:10 +02:00
Patrik Oldsberg a633dce818 docs: format with prettier (#1218) 2020-06-09 19:50:41 +02:00
Ivan Shmidt 82143b1d10 Merge branch 'master' of github.com:spotify/backstage into mob/register-unregister-components 2020-06-04 17:09:15 +02:00
Stefan Ålund 5b9f77f151 Fix image link in ADR 5 (#1125) 2020-06-03 13:19:07 +02:00
Marc Bruggmann 37ca9e1434 Clarify that we start by only implementing the Component entity 2020-06-01 17:06:00 +02:00
Marc Bruggmann 1312d34147 ADR: Core entities in the catalog
This is capturing the catalog part of the Backstage System Model
RFC (#390). I'm planning to follow this up with a second ADR on
how to express System, Application and Domain in catalog labels.

Not sure if it helps to have the example yamls inline here. It
helps me to visualize how it'd work, but it could also get outdated
quickly.
2020-05-29 10:23:01 +02:00
Patrik Oldsberg d37d7b944b docs/adr004: add clarification about internal imports 2020-05-28 00:42:23 +02:00
Patrik Oldsberg 582f636776 docs: add adr004, module export structure 2020-05-27 21:53:42 +02:00
Fredrik Adelöw 7fac93feea Add ADR about named exports 2020-05-19 16:34:50 +02:00
Fredrik Adelöw b2b3def704 Lied about the name format 2020-05-19 15:03:19 +02:00
Fredrik Adelöw 8678a3cd31 Address comments 2020-05-19 14:08:10 +02:00
Fredrik Adelöw 86bb6cc6a8 ADR002: Default Software Catalog File Format 2020-05-18 14:10:02 +02:00
eywoon 9ccf3b0623 add adr log to repository (#665) 2020-04-29 10:25:44 +02:00