Commit Graph

56 Commits

Author SHA1 Message Date
Patrik Oldsberg 021c70d673 Merge pull request #4564 from backstage/rugvip/docker-builds
docker: switch to backend:bundle + update docs with both host and multi-stage build
2021-02-18 11:01:47 +01:00
Fredrik Adelöw 6ebb0b19e9 Merge pull request #4561 from backstage/freben/integrations1
a small start to the integrations section of the config
2021-02-18 09:40:33 +01:00
Patrik Oldsberg d13aea9cd2 docs: add full docker deployment docs 2021-02-17 20:44:10 +01:00
Fredrik Adelöw 83ff0988b1 a small start to the integrations section of the config 2021-02-17 13:50:08 +01:00
blam d7abf2a2db chore: fix some other wording 2021-02-16 15:19:31 +01:00
Fredrik Adelöw 77fe4ef3cd docs: add a miniature article about observability 2021-02-01 17:09:03 +01:00
Himanshu Mishra 8e46135702 docs: Remove broken installation page 2021-01-29 14:10:15 +01:00
Oliver Sand e0d495dc52 Merge pull request #4260 from SDA-SE/feat/adr011-plugins-package-structure
Add ADR for Plugin Package Structure
2021-01-27 23:12:14 +01:00
Oliver Sand fb118a6cf2 Add ADR for Plugin package Structure 2021-01-26 19:15:45 +01:00
Adam Harvey 8abed46a1f Reorg Kubernetes section 2021-01-25 14:42:10 -05:00
Andrew Thauer 54dd7b3003 Merge pull request #3980 from andrewthauer/date-lib-adr
docs: add use luxon date library adr
2021-01-19 12:42:53 -05:00
Andrew Thauer e58af307f0 docs: add use luxon date library adr 2021-01-19 10:08:17 -05:00
Himanshu Mishra d9de82ee6c docs: How to build TechDocs sites on CI/CD workflows 2021-01-19 13:18:35 +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
Himanshu Mishra e2030972fc Merge pull request #4062 from backstage/orkohunter/use-urlreader-in-techdocs 2021-01-15 13:12:45 +01:00
Patrik Oldsberg b6d6295f1d Merge pull request #4072 from backstage/rugvip/docompost
docs: add documentation and migration instructions for new composability API
2021-01-15 13:02:06 +01:00
Emma Indal 057cb8e84f Backstage Glossary Documentation (#4073)
* add Backstage Glossary documentation

* Update docs/glossary.md

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

* Update docs/glossary.md

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>

* Update docs/glossary.md

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>

* updates from feedback

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
2021-01-15 10:45:39 +01:00
Himanshu Mishra b2fc74ea16 docs: Write a HOW TO guide for using URL Reader 2021-01-14 12:22:45 +01:00
Patrik Oldsberg 72ce0f8b16 docs/composability: include in sidebar and add note about purpose 2021-01-14 02:05:45 +01:00
Himanshu Mishra 92e9fc9103 docs: move Kubernetes to core features (#4038) 2021-01-12 21:46:40 +00:00
Matthew Clarke 5a9a7e7c26 Kubernetes plugin: UI revamp (#3918)
* initial revamp, no error reporting

* initial error detection

* more error detection

* add microsite page

* minor fixes

* add HPA error detection

* refactor error reporting; add tests

* fix import

* add changeseet

* empty error state

* prettier yaml file

* Update plugins/kubernetes/src/components/KubernetesDrawer/KubernetesDrawer.tsx

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>

* Update plugins/kubernetes/src/components/KubernetesDrawer/KubernetesDrawer.tsx

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>

* PR feedback

* revert odd change

* make patch change

* fix test

* Apply suggestions from code review

Co-authored-by: Fredrik Adelöw <freben@gmail.com>

* prettier

* pr feedback

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-01-11 16:50:30 +00:00
Patrik Oldsberg e0426d00ed docs/cli: skip under the hood docs for now 2020-12-14 10:05:45 +01:00
Patrik Oldsberg c7507fe240 docs: initial cli docs skeleton + commands extraction 2020-12-13 13:15:01 +01:00
Himanshu Mishra 084670b37a Google Cloud Storage working with TechDocs (publish and fetch)
Plus
1. Introduce ncessary configs to connect with storage
2. Introduce config to prefer CI build of docs, or techdocs-backend to build and publish them.
3. Write guide how to use Google Cloud Storage with TechDocs
4. Add a TechDocs Configuration reference page in docucmentation
2020-12-03 22:40:15 +01:00
Patrik Oldsberg 64d2d56123 Merge pull request #3289 from backstage/rugvip/stability
docs: add stability index
2020-11-20 09:53:34 +01:00
Fredrik Adelöw 3ad6320029 docs: catalog - extending the model, and relations (#3291)
* docs: catalog - extending the model, and relations

* Address comments
2020-11-16 16:45:46 +01:00
Patrik Oldsberg 8c1662fbf9 docs: add stability index
Co-authored-by: blam <ben@blam.sh>
2020-11-13 12:55:56 +01:00
Stefan Ålund 4df45e0083 (docs) Add Helm charts, cleanup (#2944)
* (docs) Add Helm charts, cleanup

* (docs) Add Helm charts, cleanup
2020-10-17 20:54:47 +02:00
Marcus Eide c805350b72 Add documentation section about the project structure (#2880) 2020-10-14 09:50:41 +02:00
Fredrik Adelöw 277b1181ad Merge pull request #2532 from spotify/freben/ref
feat(freben): add handling and docs for entity references
2020-09-25 08:41:29 +02:00
Himanshu Mishra 94aa8068af TechDocs: Add troubleshooting docs 2020-09-24 16:20:16 +02:00
Stefan Ålund 06ae3734e7 [docs] Add links to CNCF information (#2570)
* [docs] restructure

* Add CNCF links

* Update background.md

* Update Footer.js

* Update README.md
2020-09-24 14:33:30 +02:00
Fredrik Adelöw 0222279021 feat(freben): add handling and docs for entity references 2020-09-22 15:27:13 +02:00
Fredrik Adelöw f7a57e89d0 Merge pull request #2501 from spotify/freben/more-github
fix(catalog-backend): unify github and github/api, and use git-url-parse
2020-09-18 15:06:18 +02:00
Fredrik Adelöw 94b8e88eba fix(catalog-backend): address comments and add docs 2020-09-18 10:00:58 +02:00
Jesse Alan Johnson 975b97daf2 new tutorials (#2435)
* new tutorial

* prettier formatting

* Update quickstart.md

* prettier write

* refined quickstart tutorial

* Create QuickStart-app-plugin

* Rename QuickStart-app-plugin to quickStart-app-plugin

* Update and rename quickStart-app-plugin to quickstart-app-plugin

* Adding second tutorial with prettier

* removing rogue file

* updating where to go link

* adding sidebars entry for new tutorials
2020-09-17 20:41:13 +02:00
Fredrik Adelöw 8989e83475 Merge pull request #2446 from spotify/freben-patch-2
Add reference to well known annotations
2020-09-14 09:29:04 +02:00
Fredrik Adelöw 8a0adf950a Update mkdocs.yml etc 2020-09-14 09:07:22 +02:00
Himanshu Mishra 08856c7da9 Add TechDocs architecture page 2020-09-11 23:54:28 +02:00
Himanshu Mishra 7da352e200 Use TechDocs instead of docs-like-code 2020-09-11 23:20:44 +02:00
Himanshu Mishra 3e85b8cf91 Fix docs sidebar for docs gettings started 2020-09-11 00:28:16 +02:00
Stefan Ålund 242bc8d111 Add Backstage logo assets (#2395)
* Add Backstage logo assets

* Update logos.md

* Update logos.md

* docs/verify-links: allow absolute URLs into microsite/static

Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
2020-09-10 13:26:41 +02:00
Patrik Oldsberg b9660715ef microsite: install docs 2020-09-09 20:36:47 +02:00
Stefan Ålund 0a1416d476 [Docs] Clarify what is core features (#2314) 2020-09-07 19:44:17 +02:00
Patrik Oldsberg b045b166b6 run prettier 2020-09-05 16:37:30 +02:00
Ivan Shmidt 68474750db Merge branch 'master' of github.com:spotify/backstage into shmidt-i/app-catalog-tabs-routes-everything-is-connected 2020-08-31 23:21:23 +02:00
Ivan Shmidt 713060d1f3 docs: plugin integration into catalog 2020-08-31 23:18:06 +02:00
Iain Billett b284cb38e3 Add Plugins Page to microsite (#2144)
* Add Plugins Page to microsite

* Updates to microsite Plugins Page

* Correct plugin authors and documentation links
* Add category to UI
* Move documentation from README to the docs website
* Use external urls for logos

* Updates to microsite Plugins Page

* trailing whitespace
* Run prettier on new markdown

* Updates to microsite Plugins Page

* Move plugins link
* Clarify category field

* Updates to microsite Plugins Page

* Add authorUrl field to plugin config
* Render author as a muted link like those in the site map

* Updates to microsite Plugins Page

* Add authorUrl field to example in docs

* Updates to microsite Plugins Page

* Add npmPackageName field - intended for future use

* Updates to microsite Plugins Page

* Add npmPackageName field - intended for future use

* Updates to microsite Plugins Page

* Use correct docs link
2020-08-31 14:30:43 +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
Stefan Ålund 889e1fd4bb Docs: strategies for adopting Backstage (#2092)
* Adopting guidelines

* More updates

* Tactics

* Add metrics

* Add MTTR
2020-08-24 16:37:51 +02:00