Commit Graph

32 Commits

Author SHA1 Message Date
Himanshu Mishra 00342b7ab4 Document how techdocs container is published 2020-10-05 18:30:53 +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
Emma Indal 6b8a6d8d52 fix(techdocs-core): change development status of techdocs core package (#2589) 2020-09-24 11:26:25 +02:00
Emma Indal 4ee2c6a16d fix(techdocs-core): use the content of the readme as long description for the pypi package (#2578) 2020-09-24 09:03:33 +02:00
Emma Indal 646407fcf4 Bump version of techdocs-core plugin in techdocs-container (#2539) 2020-09-21 18:21:41 +02:00
Emma Indal 959e2e9866 TechDocs: adjust mkdocs extensions (#2516)
* fix(techdocs-core): adjust mkdocs extensions

* fix(techdocs-core): formatting

* fix(techdocs-core): bump version)

* move highlight configs to extension

* delete extension from mkdocs yaml

* formatting

* fix(docs): add links to plugins and extensions in docs

* prettier

* fix(techdocs-core): use pymdownx extensions v.7.1 to allow legacy_tab_classes config

* fix(techdocs-core): delete unused import

* update changelog

* added superfences to list of extensions

* prettier
2020-09-21 18:03:13 +02:00
Sebastian Qvarfordt 3206acb784 Bumped mkdocs-techdocs-core version in techdocs-container (#2484) 2020-09-16 11:36:15 +02:00
Emma Indal 2b555ca1d9 TechDocs: fix pymdown emoji configs (#2482)
* fix pymdown emoji configs

* Added changelog, bumped version

Co-authored-by: Sebastian Qvarfordt <s.qvarfordt@gmail.com>
2020-09-16 11:18:48 +02:00
Sebastian Qvarfordt 124663682f Bumped techdocs-core version in container (#2475) 2020-09-15 17:29:19 +02:00
Sebastian Qvarfordt 5236eb6709 Bumped version of pymdown-extensions for compatability (#2474) 2020-09-15 17:11:48 +02:00
Sebastian Qvarfordt fb118379e8 Mob/techdocs downgrade markdown plugins (#2473)
* Use more tested versions of markdown plugins

* Less specific mkdocs version required

* Bump version

* Added changelog

* Bumped version of techdocs-core plugin

* Fixed lint issue
2020-09-15 16:29:13 +02:00
Sebastian Qvarfordt a1386be0bd Use more tested versions of markdown plugins (#2472)
* Use more tested versions of markdown plugins

* Less specific mkdocs version required

* Bump version

* Added changelog
2020-09-15 16:05:08 +02:00
Patrik Oldsberg b045b166b6 run prettier 2020-09-05 16:37:30 +02:00
Sebastian Qvarfordt 302468971f Use version 0.0.4 of techdocs-core (#2260)
* Use version 0.0.4 of techdocs-core

* Removed unnecessary log
2020-09-03 10:37:16 +02:00
Sebastian Qvarfordt 043b0d927d TechDocs: Added more plugins to mkdocs (#2215)
* Added more plugins to mkdocs

* Added missing file

* wait with katex extension

* delete math equations example

* add changelog to readme to keep track of changes

* Updated plantuml executable in dockerfile

* Update packages/techdocs-container/Dockerfile

Co-authored-by: Emma Indal <emmai@spotify.com>
2020-09-03 10:11:02 +02:00
Emma Indal b602a7b729 Remove WIP (#2185) 2020-08-31 15:13:42 +02:00
ellinors e14962205a fix(techdocs): updated mkdocs-techdocs-core in techdocs-container Docker file. 2020-07-30 10:19:50 +02:00
Sebastian Qvarfordt 276dd590f1 fix(techdocs-core): formatting 2020-07-29 12:52:53 +02:00
Sebastian Qvarfordt 044b1d4201 Does not bump mkdocs-techdocs-core in dockerfile yet since it's not published 2020-07-29 11:55:45 +02:00
Sebastian Qvarfordt 891b1cebb7 feature(techdocs-core): Initial version of metadata generation of mkdocs data 2020-07-29 11:49:01 +02:00
Sebastian Qvarfordt d73f5395c7 Merge pull request #1701 from spotify/mob/techdocs-cli-updates
TechDocs: techdocs cli updates
2020-07-21 16:32:08 +02:00
Emma Indal 1a89adb9cf Merge pull request #1691 from spotify/mob/publish-pip-package
Added techdocs-core pip publish in master workflow
2020-07-21 13:53:23 +02:00
Emma Indal 0d9b0a0dc9 fix(techdocs-container): update techdocs-container docs 2020-07-21 11:57:54 +02:00
Emma Indal 5212dac0c1 Merge pull request #1694 from spotify/mob/techdocs-use-techdocs-pip-in-dockerfile
Update dockerfile to use published package of techdocs-core
2020-07-21 10:17:47 +02:00
Emma Indal 04114524ca fix(techdocs-core): update installation instructions 2020-07-21 08:34:37 +02:00
Emma Indal 2f2ee5e426 change used version of mkdocs-techdocs-core 2020-07-20 18:02:06 +02:00
Sebastian Qvarfordt 8f0fbeba03 Bumped version of techdocs-core pip package 2020-07-20 17:56:18 +02:00
Sebastian Qvarfordt 0c820a7f6b Update dockerfile to use published package of techdocs-core 2020-07-20 17:03:42 +02:00
Sebastian Qvarfordt eb034cba8a Updated use of env variable again 2020-07-20 16:31:07 +02:00
ellinors fd935dc4a3 fix: updated techdocs container docs 2020-07-13 14:40:31 +02:00
Bilawal Hameed 68d472f702 docs: updated to packages/techdocs-container 2020-07-10 16:17:22 +02:00
Bilawal Hameed 4f709b4a25 fix: migrate techdocs-container to packages/ 2020-07-10 16:05:14 +02:00