Commit Graph

27 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
Patrik Oldsberg d994ed61a2 docs: regenerate api reference docs 2020-09-22 11:42:21 +02:00
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Patrik Oldsberg c84bfb5ca6 docs: sync api reference docs 2020-09-09 10:45:56 +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 c6c3c94c18 Camelcase GitHub and GitLab (#2034)
* Camelcase GitHub and GitLab

* GitLab

* Code GitLab

* GitHub in code

* Fix auth naming

* Update docs/features/software-templates/adding-templates.md

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>

* Update docs/features/software-templates/extending/create-your-own-preparer.md

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>
2020-08-21 14:48:16 +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
Chris Simmons 1c559bcc90 Enable override of sidebar selected indicator color when using createTheme (#1880)
* refactored sidebar palette types + updated default themes

* use @backstage/theme and new selectedIndicatorColor palette property

* fixed sidebar to use refactored backgroundColor property

* simplified property names based on feedback

* renamed sidebar to navigation in palette

* updated AppThemeApi docs with PaletteAdditions changes
2020-08-11 08:16:46 +02:00
Patrik Oldsberg b5b976270d docs: regenerated utility api reference docs 2020-08-08 12:09:00 +02:00
Patrik Oldsberg c75beb460d docs: regenerate api reference docs 2020-07-19 14:27:36 +02:00
Patrik Oldsberg 8cd5fb5e7c docs: generate utility api reference 2020-07-19 14:27:34 +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
Patrik Oldsberg a633dce818 docs: format with prettier (#1218) 2020-06-09 19:50:41 +02:00
Ivan Shmidt af56473342 NavLink->Link, NavButton->Button, remove redirects for now 2020-06-04 00:03:34 +02:00
Ivan Shmidt 0a13a11f7b Enforcing RouteRefs more: docs, templates, types 2020-06-03 16:40:13 +02:00
Bilawal Hameed 8fce6e90b5 fix(feature-flags): corrected docs to instantiate FeatureFlags 2020-04-18 16:55:42 +02:00
Bilawal Hameed f1acc3e0bc Fix code sample 2020-03-31 23:04:56 +02:00
Bilawal Hameed 70252160e5 [core] change FeatureFlagState to {On,Off} 2020-03-30 12:29:54 +02:00
Bilawal Hameed 64a14b2191 [core/apis] adapted to build on existing data structures 2020-03-30 12:07:38 +02:00
Bilawal Hameed a8f304dbfb [docs/reference] updated to reflect React Hooks changes 2020-03-30 12:07:38 +02:00
Bilawal Hameed 92d091dec8 [core/apis] consolidated methods to get/set 2020-03-30 12:07:38 +02:00
Bilawal Hameed 71072da838 [docs] updated to reflect both useApi and FeatureFlags object 2020-03-30 12:07:38 +02:00
Bilawal Hameed 817c476050 [docs] updated with typescript definitions + code sample 2020-03-30 12:07:37 +02:00
Bilawal Hameed 8145ba8b94 [docs] added skeleton 2020-03-30 12:07:37 +02:00
Patrik Oldsberg 3a0d8edcb5 rename npm namespace from @spotify-backstage to @backstage 2020-03-25 19:12:11 +01:00
nikek 85f5ca9441 Structure documentation in /docs 2020-03-13 18:59:15 +01:00