Commit Graph

68 Commits

Author SHA1 Message Date
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
Mayurs 17c30eaf3e fix(docs): Fix typos in several .md files (#2627) 2020-09-27 18:57:20 +02:00
Fredrik Adelöw 56b82f523d chore: add contrib to CONTRIBUTING.md (#2585) 2020-09-24 07:55:54 +02:00
Taras Mankovski 8ae216a29e Update CONTRIBUTING.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2020-09-16 18:15:03 -04:00
Taras Mankovski b22320e6c7 Add changeset instructions to CONTRIBUTING.md 2020-09-16 15:54:06 -04:00
Himanshu Mishra 51b94bd82c Remove duplicate instructions from contributing guide 2020-09-11 10:47:02 +02:00
Stefan Ålund ee0310213c Tweaks to plugin marketplace (#2209)
* Tweaks to plugin marketplace

* Add plugin details to roadmap

* Update README.md

* Link to plugins from home

* Update circleci.yaml
2020-09-01 14:27:33 +02:00
Patrik Oldsberg 7c4307d1ee docs: update storybook url 2020-08-14 09:20:09 +02:00
Ivan Shmidt 9b439375cf Merge branch 'master' of github.com:spotify/backstage into mob/docusaurus-structure 2020-08-12 16:04:54 +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
Patrik Oldsberg 4bc9a33a3c docs: split getting started section in readme into create-app vs clone
Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 14:19:22 +02:00
Patrik Oldsberg d1b2a6ccd1 Add coding guidelines to CONTRIBUTING 2020-07-29 11:12:52 +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 86e399221c Link to SECURITY in CONTRIBUTING 2020-06-12 08:43:57 +02:00
Adil Alimbetov f72d97dc17 Sidebar logo update (#814)
* Testing logo ux

* Updated logo on sidebar

* removed unused vars

* adjusted types on icon components
2020-05-27 10:13:41 +02:00
Remy DeCausemaker 5ffabfe2bb Update CONTRIBUTING.md (#929) 2020-05-19 21:59:29 +02:00
Stefan Ålund 151417a9ed Document how to suggest new plugins (#590)
* Document how to suggest new plugins

* Update plugin_template.md

* Update ux-component_template.md

* Update plugin_template.md
2020-04-18 18:00:15 +02:00
Stefan Ålund eb76a4d05a Add CONTRIBUTING (#572)
* Add CONTRIBUTING

* Update CONTRIBUTING.md

* Fixed review comments

* Typo
2020-04-17 10:53:11 +02:00