Commit Graph

69 Commits

Author SHA1 Message Date
Andre Wanlin 9d2c6a7db4 Removed from create-app and added to docs
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-11-18 12:25:50 -06:00
Phil Kuang 3e4a2ee779 docs(scaffolder): add info about custom field explorer
Signed-off-by: Phil Kuang <pkuang@factset.com>
2022-11-11 14:37:10 -05:00
Matthew Boyle 502ebe7d24 update the configuration steps of the docs
Signed-off-by: Matthew Boyle <matt-boyle@hotmail.co.uk>
2022-10-26 08:06:16 +01:00
Andre Wanlin e65f18e0a2 Removed database step from docs
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-10-12 15:35:03 -05:00
Andre Wanlin f8287e5340 Added UserSettingsAvailableIconsTable and related documentation
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-08-17 13:59:20 -05:00
Fredrik Adelöw 1d69233618 Merge pull request #11964 from pitwegner/master
Add component dependency in text and diagram
2022-06-10 13:43:35 +02:00
Pit Wegner 2fa8826678 add component dependency in text and diagram
Signed-off-by: pitwegner <pit.wegner@student.hpi.de>
2022-06-10 02:22:56 -07:00
Anders Näsman a33399ed59 fixup to arch diagram
Signed-off-by: Anders Näsman <andersn@spotify.com>
2022-06-10 10:27:58 +02:00
Anders Näsman f28bc28834 update docs
Signed-off-by: Anders Näsman <andersn@spotify.com>
2022-06-10 10:27:57 +02:00
Joon Park ca98fe0b29 Rename permission docs path to plural (#11648)
* Rename permission docs path to plural

Signed-off-by: Joon Park <joonp@spotify.com>

* Update todo list plugin READMEs

Signed-off-by: Joon Park <joonp@spotify.com>
2022-05-26 14:58:19 +01:00
Camila Belo 9add676fbb docs(techdocs): add-ons getting started
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2022-05-16 16:17:07 +02:00
Camila Belo 3711bc6031 feat(techdocs): create text size addon
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2022-05-07 11:01:31 +02:00
Joe Porpeglia b5b349b09d Copy updates
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2022-04-29 11:05:03 +01:00
Vincenzo Scamporlino 23fc22c6dd Permission framework docs for plugin authors (#9702)
* Permission framework docs: plugin adopters

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Add item to sidebar

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/permission-framework-for-plugin-authors.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Apply suggestions from code review

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Co-authored-by: Joon Park <joonp@spotify.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Apply suggestions from code review

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Docs improvements

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Add todo-list plugins

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Refactor structure and minor changes

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Fix links

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Update docs/permission/plugin-authors/setup-for-the-tutorial.md

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Apply suggestions from code review

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* minor tutorial fixes

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Fully implement permission rule

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Add todos for missing content

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Improve minified script

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* More todos

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

* Fix rules exports

Signed-off-by: Vincenzo Scamporlino <me@vinzscam.dev>

Co-authored-by: MT Lewis <mtlewis@users.noreply.github.com>
Co-authored-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:02 +01:00
Joon Park f26bcf41a0 Add getting started docs for permissions (for adopters) (#9810)
* Add getting started docs for permissions (for adopters)

Signed-off-by: Joon Park <joonp@spotify.com>

* Minor formatting and wording fixes

Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:02 +01:00
Joon Park be21be4108 Permission framework docs overview (#9412)
* Permission framework docs overview

Signed-off-by: Joon Park <joonp@spotify.com>

* Address comments

Signed-off-by: Joon Park <joonp@spotify.com>
2022-04-29 11:05:02 +01:00
Eric Peterson 64889b7706 Add an illustration of Addon locations.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-04-27 15:46:39 +02:00
Patrik Oldsberg f8b0197fc2 docs: add section to help decide where to place code
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-11 15:21:19 +02:00
Eric Peterson 5960b78a4c Document task scheduler / DB. And improve throughout.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-04-08 18:13:45 +02:00
Dimitris Apostolou aedd4daa66 Fix typos
Signed-off-by: Dimitris Apostolou <dimitris.apostolou@icloud.com>
2022-03-13 14:12:05 +02:00
Himanshu Mishra 821bebdff7 complete instructions on setting up custom homepage
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-02-09 11:02:02 +01:00
Patrik Oldsberg 05f5bb5b53 docs: switch package architecture diagram to .drawio.svg
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-01-05 16:08:01 +01:00
Patrik Oldsberg 1834a02e16 docs: fix package architecture diagram reference
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-01-03 18:00:14 +01:00
Suzanne Daniels 160d6b71e9 Merge branch 'backstage:master' into suuus/docs-2 2021-12-21 09:47:47 +01:00
Otto Sichert 731e9293bd Merge pull request #6335 from backstage/iameap/techdocs-cache
[TechDocs] Optional static resource caching
2021-12-06 10:38:30 +01:00
Suzanne Daniels 44c7298875 Added screenshots, improving text
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-12-01 20:52:54 +01:00
Eric Peterson e4adc768a5 Update architecture diagram.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:16:04 -07:00
Eric Peterson 0a5278b92a Update Backstage.io docs with config/recs
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:16:04 -07:00
Eric Peterson d5699813f7 Proposed architecture.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-11-28 13:13:30 -07:00
jrusso1020 fa683cab7d address comments
Signed-off-by: jrusso1020 <jrusso@brex.com>
2021-11-27 12:36:29 -05:00
Andrew Thauer 71e7b0ee92 refactor: reunification of techdocs-cli and backstage repos
Signed-off-by: Andrew Thauer <athauer@wealthsimple.com>
2021-11-11 19:31:55 +01:00
Suzanne Daniels 9daaf366c1 Delete imgs
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-07 17:20:30 +02:00
Suzanne Daniels 91ae05b8ec rename img to match styleguide
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-07 17:20:30 +02:00
Suzanne Daniels bd6f4fb2d9 Getting started guide rewrite
Signed-off-by: Suzanne Daniels <suzanned@spotify.com>
2021-10-07 17:20:30 +02:00
Fredrik Adelöw abe071e7f3 do stitching as well
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-09-04 20:30:31 +02:00
Fredrik Adelöw aeb7474e20 add the processing part of the life-of-an-entity
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-09-03 11:42:33 +02:00
Fredrik Adelöw a004b8da1a add a 'life of an entity' catalog article
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-08-31 12:06:51 +02:00
Joe Porpeglia 709589a839 Rename service catalog to software catalog, excluding blog posts
Signed-off-by: Joe Porpeglia <josephp@spotify.com>
2021-06-21 11:48:43 -04:00
Oliver Sand 8a7799d850 Fix images on github org data page
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-05-25 13:33:44 +02:00
Anders Näsman 124b93bff4 rename plugin-search-indexer to plugin-search-backend-node
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-03-19 09:42:45 +01:00
ImgBotApp 2df4eb8314 [ImgBot] Optimize images
/docs/assets/architecture-decisions/catalog-core-entities.png -- 20.55kb -> 7.81kb (61.99%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
2021-03-16 16:16:17 +00:00
Tim Hansen 5ee959802c Minor tweaks to software catalog docs
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2021-03-15 14:07:00 -06:00
ImgBotApp 91f110ca29 [ImgBot] Optimize images
*Total -- 279.29kb -> 230.81kb (17.36%)

/microsite/static/img/splunk-black-white-bg.png -- 4.35kb -> 2.18kb (49.84%)
/plugins/jenkins/src/assets/JenkinsLogo.svg -- 29.10kb -> 23.76kb (18.37%)
/docs/assets/dls/storybook-page.png -- 245.84kb -> 204.87kb (16.66%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
2021-03-03 21:46:39 +00:00
Adam Harvey 8d8b3087f1 Update to latest image
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
2021-03-02 22:51:25 -05:00
Eric Peterson 5472e07abb Break apart backend plugins & clarify indexer/plugin relationship. 2021-02-10 14:38:31 +01:00
Adam Harvey 8abed46a1f Reorg Kubernetes section 2021-01-25 14:42:10 -05:00
Himanshu Mishra 6c64b4b8b9 docs: Search arch diagram catalogue -> catalog 2021-01-19 13:56:18 +01:00
Emma Indal 85d864c19f Search Roadmap and Architecture (#4030)
* search documentation and roadmap

* fixup

* add link to architecture issue

* formatting

* add nav to mkdocs yaml and microsite sidebar

* use backstage search instead of backstage global search

* add file extension to app_config

* Update docs/features/search/README.md

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>

* replace Big Picture with Architecture

* search architecture wip

* changes to architecture and documentation to it

* update used user profiles according to the glossary

* prettier ignore description

* clarify architecture bullet points with examples

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-01-18 12:01:54 +01:00
Oliver Sand c773e00d54 Remove providesApis and consumesApis from systems
We can later add them again.
2021-01-12 15:05:47 +01:00
Oliver Sand 580b4cad8e Use dependsOn between components and resources for now 2021-01-11 22:09:59 +01:00