Commit Graph

60 Commits

Author SHA1 Message Date
Oliver Sand f816a54da2 docs: fix a minor typo (#2718) 2020-10-02 11:31:19 +02: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
Gary Niemen 73440c7d9a techdocs-milestones-update (#2705) 2020-10-01 17:39:05 +02:00
Emma Indal abd4119726 Update docs/features/techdocs/concepts.md 2020-10-01 11:49:59 +02:00
Emma Indal c8f8105c9c prettier 2020-10-01 11:49:06 +02:00
Emma Indal 4bb947137c Update the publisher section 2020-10-01 11:45:44 +02:00
Himanshu Mishra 5dff92ca11 Run prettier on doc files 2020-10-01 08:54:14 +02:00
Ian Cowley d0bfdf8ee5 techdocs: make some small improvements to faq
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.
2020-10-01 08:28:59 +02:00
Navaneeth Suresh e7686833fd docs: fix typos in the documentation (#2633) 2020-09-28 13:18:40 +02:00
Himanshu Mishra 94aa8068af TechDocs: Add troubleshooting docs 2020-09-24 16:20:16 +02:00
Patrik Oldsberg 521728348d backend: change the default backend plugin mount point to /api 2020-09-23 09:39:47 +02:00
Sebastian Qvarfordt f097c32b59 TechDocs: Use a flag to determine if we should use a local mkdocs or techdocs-container (#2503)
* 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
2020-09-18 14:02:35 +02:00
Rajiv Ranjan Singh 485fa981d2 prettified md 2020-09-17 01:38:58 +05:30
Rajiv Ranjan Singh 3347cf1668 grammar correction 2020-09-17 00:14:06 +05:30
Rajiv Ranjan Singh ff65589796 added description header field 2020-09-16 23:06:14 +05:30
Rajiv Ranjan Singh d833cd9fe8 added description header field 2020-09-16 22:14:28 +05:30
Rajiv Ranjan Singh 812da7539f added description header field 2020-09-16 21:56:32 +05:30
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Ben Lambert 0597211af1 Merge pull request #2433 from timja/support-user-or-org
scaffolder: Allow user or org, remove hard coded isOrg
2020-09-15 09:17:25 +02:00
Himanshu Mishra b1051d50e8 Add FAQ about file formats 2020-09-12 00:09:07 +02:00
Himanshu Mishra e87263e839 Some minor improvements to docs 2020-09-12 00:01:11 +02:00
Himanshu Mishra 7b1b539e8c Remove the manual edit instructions
There is an edit button on the website
2020-09-12 00:00:40 +02:00
Himanshu Mishra 506d130854 Some minor improvements to docs 2020-09-11 23:55:01 +02:00
Himanshu Mishra 08856c7da9 Add TechDocs architecture page 2020-09-11 23:54:28 +02:00
Himanshu Mishra a5e6e17fd3 Avoid duplication, redirect to Backstage getting started 2020-09-11 23:38:34 +02:00
Himanshu Mishra 64d2edc097 Updates to the TechDocs overview page
- 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
2020-09-11 23:35:32 +02:00
Tim Jacomb c95fd141ae Remove hardcoded isOrg 2020-09-11 22:17:58 +01:00
Emma Indal 0b95f633d9 Update v1 milestone in project roadmap 2020-09-11 08:07:34 +02:00
Patrik Oldsberg 902781c36f docs: fix broken fragment links 2020-09-10 17:50:36 +02:00
Tim Jacomb 72c097f57f Use correct npm package for serving 2020-09-10 09:08:23 +01:00
Sebastian Qvarfordt d865f88344 [TechDocs] Rebuild docs if the github source is newer than last docs build (#2353)
* 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>
2020-09-09 16:05:28 +02:00
Omer Farooq 0fa4c72a92 revert yarn.lock
upgrade Storybook to version 6

update storybook renderer layout

docs: update create app command and link

revert yarn.lock changes

revert yarn.lock

revert yarn
2020-09-09 00:37:06 +12:00
Patrik Oldsberg b045b166b6 run prettier 2020-09-05 16:37:30 +02:00
Emma Indal cd3dde5af6 add techdocs big picture to docs (#2153) 2020-08-28 11:56:22 +02:00
Emma Indal 2bb585f4fe TechDocs: add note to docs about limitations to the scaffolder (#2134)
* add warning to docs about limitations to the scaffolder

* Update docs/features/techdocs/creating-and-publishing.md
2020-08-27 13:15:09 +02:00
Sebastian Qvarfordt 0b2f787699 Updated docs for techdocs plugin (#2127)
* 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>
2020-08-27 09:52:49 +02:00
Emma Indal 40de8e03d4 TechDocs: update techdocs docs (#2105)
* 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
2020-08-25 16:43:14 +02:00
Emma Indal 8d4e14e1c5 Update versions in upcoming features 2020-08-14 15:07:03 +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
Ivan Shmidt 0867d3dc30 feat: more docs to backstage.io 2020-08-12 12:06:14 +02:00
Emma Indal 7529211cc0 fix(roadmap): switch links to milestones for v2 and v3 2020-08-11 20:07:17 +02:00
Emma Indal 38737c9e73 fix(roadmap): adjust project roadmap and link to use cases for v2 2020-08-11 20:04:09 +02:00
Sebastian Qvarfordt b0032f9739 Added v2 to techdocs readme 2020-08-11 18:47:34 +02:00
Emma Indal 7462a1d5a1 fixup 2020-08-10 14:29:59 +02:00
Emma Indal 96bc61aeb2 Add use cases connected to TechDocs versions in project roadmap 2020-08-10 14:25:26 +02:00
Bodil Björklund 0fe2ddf70f Tweaks to techdocs docs
Text editing
2020-07-30 17:04:03 +02:00
ellinors fb3284a35b fix(techdocs): clean up unused links 2020-07-22 11:55:16 +02:00
ellinors 12f4979cdf fix(techdocs): updated link in techdocs README.md to point to new file 2020-07-22 11:53:06 +02:00
ellinors ebdfadc3f9 fix(techdocs): remove unused doc files and merge some docs into one file 2020-07-22 11:51:42 +02:00
ellieseastream 5c61ec0ed5 Merge pull request #1703 from spotify/emmai/techdocs-docs-concepts
Techdocs: concept documentation
2020-07-21 17:05:03 +02:00