Commit Graph

144 Commits

Author SHA1 Message Date
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
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
blam 74e1cc5d96 docs(deployment): fixing documentation 2020-07-15 15:55:08 +02:00
Stefan Ålund f59dd3a073 [Docs] Fix broken links and more 2020-07-15 12:24:15 +02:00
blam 13762a0405 docs(getting-started): remove the docker stuff from development and move to deployment local instead 2020-07-15 10:51:42 +02:00
blam 76952ea307 feat(docker-compose): added a simple docker compose to get people started with example backend and frontend 2020-07-15 10:47:25 +02:00
ellinors c9df3a3f32 Merge branch 'master' of github.com:spotify/backstage into mob/techdocs-publishing-documentation 2020-07-15 10:11:44 +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
ellinors 0349b22948 docs(techdocs): pratial documentation on how to publish documentation in techdocs 2020-07-14 17:24:29 +02:00
ellinors 04ad54cba2 docs(techdocs): added content to getting started with techdocs as a plugin to Backstage. 2020-07-14 15:00:18 +02:00
ellinors a1565b30f7 docs(techdocs): added intro, features, roadmap 2020-07-14 11:07:56 +02:00
Bilawal Hameed f2dd70fee5 techdocs: Add skeleton end-to-end documentation (#1600)
* docs(techdocs): add basic structure

* chore: add techdocs-core to docs/features/techdocs

* fix: separated out links

* fix: convert into markdown table
2020-07-13 17:08:01 +02:00
Ivan Shmidt 021b03669a docs(proxy): add link to plugin creation docs 2020-07-13 11:19:20 +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
Jeff Feng 6189b5d5b9 Update FAQ.md (#1464)
* Update FAQ.md

— Changed anchor links to relative links (/docs/FAQ.md#heading-name)
— Restored the heading + answer for "What is a "plugin" in Backstage?"
— Cleaned up extra spaces throughout and added line breaks to the answer for "What is the end-to-end user flow?".

* Update FAQ.md
2020-06-29 14:24:56 +02:00
Raghunandan Balachandran f29b9017ba fixing doc links (#1456) 2020-06-29 14:24:56 +02:00
Remy DeCausemaker 307ddaa86a Patch 3: Fixes #1323 (#1461)
* Updated FAQ with correct link

“Will Spotify’s internal plugins be open sourced, too?” had an incorrect link, and I added the correct one.

* Update FAQ.md

* Update FAQ.md

* Fix links to include full path to .md files

Co-authored-by: Nikki Beesetti <12538017+nikkibeesetti@users.noreply.github.com>
Co-authored-by: Stefan Ålund <alund@spotify.com>
2020-06-29 14:24:56 +02:00
Jeff Feng ced2fb1925 Update FAQ.md (#1464)
* Update FAQ.md

— Changed anchor links to relative links (/docs/FAQ.md#heading-name)
— Restored the heading + answer for "What is a "plugin" in Backstage?"
— Cleaned up extra spaces throughout and added line breaks to the answer for "What is the end-to-end user flow?".

* Update FAQ.md
2020-06-26 09:09:10 +02:00
Raghunandan Balachandran 4e57eeb101 fixing doc links (#1456) 2020-06-25 21:21:04 +02:00
Remy DeCausemaker c9354c2bff Patch 3: Fixes #1323 (#1461)
* Updated FAQ with correct link

“Will Spotify’s internal plugins be open sourced, too?” had an incorrect link, and I added the correct one.

* Update FAQ.md

* Update FAQ.md

* Fix links to include full path to .md files

Co-authored-by: Nikki Beesetti <12538017+nikkibeesetti@users.noreply.github.com>
Co-authored-by: Stefan Ålund <alund@spotify.com>
2020-06-25 21:20:19 +02:00
HamzaBoukraa 2707b5ebd6 Updating FAQ.md related to issue #1441 (#1443)
Repeated section in the FAQ #1441:
Answering the question and replacing the repeated content.
2020-06-24 22:25:48 +02:00
Patrik Oldsberg 0fa04efb97 docs/auth: add some more information about Identities 2020-06-24 19:42:41 +02:00
Patrik Oldsberg eb4e894a24 docs/auth: rename overview to README 2020-06-24 18:03:47 +02:00
blam 308c171747 Merge branch 'master' of github.com:spotify/backstage into mob/prepare-from-catalog
* 'master' of github.com:spotify/backstage: (60 commits)
  packages,plugins: remove main:src and fix some main fields
  packages/config: added get and getOptional
  changed  down caret to be up caret on user profile in the sidebar
  packages/config: add getOptionalConfig and getOptionalConfigArray to mirror other accessors
  packages/config-loader,core: update config usage to include context
  build(deps): bump @types/react from 16.9.25 to 16.9.37 (#1342)
  build(deps): bump rollup-plugin-esbuild from 2.0.0 to 2.1.0 (#1361)
  build(deps-dev): bump lint-staged from 10.2.9 to 10.2.11 (#1359)
  Polishing the Create page (#1353)
  Add some air between sidebar sections (#1355)
  Starred icon is yellow (#1351)
  Updated FAQ with Gitlab link (#1352)
  build(deps): bump react-helmet from 6.0.0 to 6.1.0 (#1327)
  packages/config: added context to keep track of where config is from for error messages
  packages/config: added .keys()
  packages/config: keep track of key prefix to display better error messages
  packages/config: optimize some error message handling
  packages/config: allow config readers to be backed by undefined data
  packages/config: flip around must* and get* to get* and getOptional*
  packages/core-api: fix invocation order when continuing to app after sign-in
  ...
2020-06-18 14:00:29 +02:00
Nikki Beesetti 19f4e434db Updated FAQ with Gitlab link (#1352)
* Updated FAQ with Gitlab link

added gitlab link

* Update FAQ.md

Co-authored-by: Stefan Ålund <alund@spotify.com>
2020-06-17 21:21:35 +02:00
Fredrik Adelöw fedfbfae58 chore(docs): more tweaks to the schema 2020-06-17 14:41:10 +02:00
Fredrik Adelöw e69a4bcdd4 chore(docs): just ran prettier on the entity schema 2020-06-17 14:15:58 +02:00
Fredrik Adelöw 00348cddb3 Merge pull request #1163 from JordiPolo/schema_file
Initial version of a json schema for the service specification
2020-06-17 14:14:27 +02:00
Nikki Beesetti b073b610f4 Updated FAQ.md with the correct links (#1308)
* Updated FAQ.md with the correct links

Two links regarding plugins were broken and now they have been fixed.

* Updated FAQ.md with correct links
2020-06-17 10:30:39 +02:00