Commit Graph

33 Commits

Author SHA1 Message Date
Dominik Henneke 9226c2aaa0 feat(proxy-backend): limit the forwarded http headers to a safe set 2020-10-08 14:30:56 +02:00
Patrik Oldsberg 34eb3a13c8 Merge pull request #2741 from spotify/rugvip/short
config-loader: add support for new short-form secret syntax
2020-10-05 13:30:04 +02:00
Stefan Ålund 8ef470b382 Update existing-plugins.md (#2717)
* Update existing-plugins.md

* prettier

* Update plugins.css
2020-10-04 22:08:05 +02:00
Patrik Oldsberg 6775deef9b update docs and examples to use shorter config secret syntax 2020-10-04 16:51:00 +02:00
Mayursinh Sarvaiya 5c6a0356c0 feat: TechDocs - Add vale linter to check words quality in md files. (#2631)
* fix(docs): typos which were reflacted from vale linter's command

* feat: Implement Vale linter (#2031)
Initialize .vale.ini file
Add 'lint:docs' script to package.json, to lint all md files except the ones which are located in node_modules
Generate 'vocab.txt' by using command 'yarn run lint:docs' | grep -o ''[a-z A-Z]*'' | grep -o '[a-z A-Z]*' | sort | uniq > .github/styles/vocab.txt
Add steps to github workflow 'master' to check docs quality

* chore: Separate workflow for quality checking

* chore: Added 'shx' dev dependency to support grep command in cross platform

* feat: Add script to operate same quality check process on different platform

* ignore: remove lint:docs from lint-stages which was added for experiment purpose

* fix: check-all-files on push event & check-changed-files on pull_request event

* chore(CI): triggle workflow only when there is any updates in .md file(s) on pull request

* fix: use spawnSync to solve 'The command line is too long.' error

* fix: github workflow syntax

* fix: prettier error

* chore: add vale command directly to lint-staged

* chore: use shebang for easy access

* fix: windows script issue & remove shebang

* chore: Add shebang flag

* chore: better error message related to vale

* chore: mention vale linter in documentation

* fix: spelling errors & add keywords to vocab.txt
2020-10-02 07:20:47 +02:00
Ben Lambert 2c33a29c7c Merge pull request #2621 from andrewthauer/fix/circleci-proxy-config
fix(circleci): add api route prefix to proxy rewrite path
2020-09-28 15:28:10 +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
Andrew Thauer 572abfe121 fix(circleci): add api route prefix to proxy rewrite path 2020-09-26 06:06:51 -04:00
Patrik Oldsberg 2caf66eb54 Update publishing.md 2020-09-25 19:22:15 +02:00
Patrik Oldsberg 7965c098b8 docs: tweak proxying docs 2020-09-25 13:50:50 +02:00
Rajiv Ranjan Singh 3347cf1668 grammar correction 2020-09-17 00:14:06 +05:30
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Dominik Henneke 7553827223 feat(proxy-backend): support limiting the proxied HTTP methods 2020-09-11 13:56:41 +02:00
Ivan Shmidt 64ecf77b78 Merge pull request #2076 from spotify/shmidt-i/app-catalog-tabs-routes-everything-is-connected
APP-driven catalog entity page with GitHub Actions integration & routes & tabs
2020-09-03 14:06:44 +02:00
Stefan Ålund 760adfda74 [plugin marketplace] Added Jenkins + polish (#2240) 2020-09-03 08:50:13 +02:00
Ivan Shmidt 7834bcaa99 Merge branch 'master' of github.com:spotify/backstage into shmidt-i/app-catalog-tabs-routes-everything-is-connected 2020-09-02 15:59:09 +02:00
Ivan Shmidt 9988479c61 refactor: address PR comments 2020-09-02 15:57:18 +02:00
Marcus Eide a7e922250a Add instructions on how to refresh existing release PR 2020-09-02 09:02:09 +02:00
Ivan Shmidt 9b0ddfe111 Merge branch 'master' of github.com:spotify/backstage into shmidt-i/app-catalog-tabs-routes-everything-is-connected 2020-09-01 10:37:18 +02:00
Oliver Sand bcbeb0b657 Add api-docs to marketplace (#2204)
* docs: improve documentation about adding plugins to the marketplace

The relative path is misleading as one has to come from root.

* docs: add api-docs plugin to marketplace
2020-09-01 09:46:46 +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
Fredrik Adelöw 9a64135bf7 move docs to the microsite 2020-08-28 14:36:13 +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
Fredrik Adelöw 89a0a2fc7b docs: write call-existing-api.md 2020-08-20 21:21:30 +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
Ivan Shmidt 0867d3dc30 feat: more docs to backstage.io 2020-08-12 12:06:14 +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
Stefan Ålund 20f030ab87 [Docs] Fixed some more links (#1648) 2020-07-15 15:59:34 +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