* 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
Made some small improvements to the FAQ. These include using the correct way to write RST and AsciiDoc, a link to the MKDocs Material Theme repo and some small style/grammar changes to the text about file formats.
* Use a flag to determine wether to use techdocs-container or local install of mkdocs
* Updated techdocs generator to look at app-config string instead of argument to decide how to run the generator
* Removed console log...
* Reverted scaffolder file that was accidentally committed.
* Fixed lint issues
* Added config to create-app template
- Add a one line context to what docs-like-code means
- Add link to announcement blog post which is very in-depth about TechDocs
- Milestone update and typo
* Added age check for documentation in github to make sure it's up to date
* Updated failing tests
* Updated docs to explain requestUrl and storageUrl
* Updated failing tests
* Update packages/create-app/templates/default-app/app-config.yaml.hbs
* Update docs/features/techdocs/getting-started.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* Updated docs for techdocs plugin
* Error in example comment
* Update plugins/techdocs/README.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* Update plugins/techdocs/src/reader/README.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* Update plugins/techdocs/src/reader/README.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* Update plugins/techdocs/src/reader/README.md
Co-authored-by: Emma Indal <emmai@spotify.com>
* Update link to transformers doc to point to reader doc for now
Co-authored-by: Emma Indal <emmai@spotify.com>
* docs(techdocs): update getting started docs
* docs(techdocs): update text and link to version
* fix docs link
* fix docs link
* Update docs/features/techdocs/getting-started.md
* update creating and publishing docs
Himanshu Mishra