1. Add a table of all the platforms that are supported and that are in pipeline. Add issue to trac
k their progress.
2. Update concepts about publisher, and add preparer and generator
3. Getting started is now complete, describes both backend and frontend, and has better setting the configuration section.
4. Some typos and code comments
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
* Add note about catalog-info.yaml convention to format docs.
* Improve TechDocs Create & Publish Docs:
- Clarify the two paths to getting started
- Clarify `catalog-info.yaml` / component registration
- Minor grammar cleanup
* Correct link to software catalog overview
* 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
Himanshu Mishra