Commit Graph

10 Commits

Author SHA1 Message Date
Adam Harvey ba99544da6 Fix filename escaping 2021-02-17 22:34:20 -05:00
Adam Harvey 33bfa45796 Clean up testing instructions 2020-12-30 01:17:20 -05:00
Frieder Bluemle cbd3a44c09 Fix typos (#3646) 2020-12-09 07:50:41 +01:00
Harvey 2e04225056 Prettier fix for line length 2020-10-26 09:49:54 -04:00
Harvey fc3e1118c8 Fix API Filenames in Examples 2020-10-26 00:03:05 -04: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
Navaneeth Suresh e7686833fd docs: fix typos in the documentation (#2633) 2020-09-28 13:18:40 +02:00
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Ivan Shmidt 0867d3dc30 feat: more docs to backstage.io 2020-08-12 12:06:14 +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