Commit Graph

19 Commits

Author SHA1 Message Date
Patrik Oldsberg 89bb53685c vale: prune accepted vocabulary
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-27 18:44:55 +02:00
LvffY f3101fb9d2 [#10459] 📝 Update documentation to use yarn --cwd arg
Signed-off-by: LvffY <louberger@hotmail.fr>
2022-03-30 15:53:05 +02:00
Patrik Oldsberg f0adfda527 api-docs: use hardcoded script sha for oauth2-redirect.html CSP
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-11-30 13:41:37 +01:00
Pavel fb7a0bdeac Update README.md
This is needed, otherwise, after you're redirected back there is an error from browser and nothing works.

Signed-off-by: Pavlo Poliakov <pavlo.poliakov@share-now.com>
2021-11-07 21:44:54 +01:00
Philipp Hugenroth 5b0b5baa5e Fix Grid in EntityPage for smaller screens
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-07-14 18:52:03 +02:00
Oliver Sand f852f7381c Revert "Add support for json schema to API docs"
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-05-03 17:25:15 +02:00
Oliver Sand 2b5506a5d7 Merge pull request #5532 from SDA-SE/feat/json-schmea
Add support for json schema to API docs
2021-05-03 13:15:50 +02:00
Fredrik Adelöw b99ac3f6e1 Minor composability etc docs changes
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-05-02 22:13:05 +02:00
Oliver Sand cec7fb9b37 Add support for json schema to API docs
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-04-29 16:27:08 +02:00
Patrik Oldsberg 74f74ccbdb Apply suggestions from code review
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-04-27 17:16:16 +02:00
Patrik Oldsberg c614ede9a5 docs: update plugin installation docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-04-22 18:32:54 +02:00
Dominik Henneke d17b39d04e Document how to customize the API docs rendering
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-04-08 18:54:15 +02:00
Alan Crosswell 7b9950ce20 Document how to install oauth2-redirect.html
Signed-off-by: Alan Crosswell <alan@columbia.edu>
2021-03-03 16:32:00 -05:00
Oliver Sand 032aba5920 Apply suggestions from code review
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2020-11-26 16:40:18 +01:00
Oliver Sand fb19e0241d Add providesApis and consumesApis to component spec 2020-11-25 16:01:34 +01: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
Andrew Thauer 678a9c90de feat: add graphql api type 2020-09-13 22:01:11 -04:00
Oliver Sand 774a000729 Readme for api-docs Plugin (#2041)
* docs(api-docs): add details to readme

* docs: fix wrong markdown in readme files
2020-08-20 13:57:59 +02:00
Dominik Henneke 812659c024 feat(api-docs): add plugin that provides widgets that display api docs 2020-08-12 13:53:34 +02:00