Commit Graph

31 Commits

Author SHA1 Message Date
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
Oliver Sand 8663917ad8 fix: resolve some dark mode styling issues
I missed them with the test file included here, but noticed it with our private test files (so no screenshot, trust me)
2020-09-29 13:35:31 +02:00
blam f326c2ee1e Merge branch 'master' of github.com:spotify/backstage into feat/backend-plugin
* 'master' of github.com:spotify/backstage: (30 commits)
  fix(techdocs-core): use the content of the readme as long description for the pypi package (#2578)
  chore: add contrib to CONTRIBUTING.md (#2585)
  Fix typo (#2584)
  backend-common: default config env to development
  v0.1.1-alpha.23
  TechDocs: Inject CSS transformer and initial backstage style integration for reader (#2560)
  bug(gql): use import to import the graphql module
  Rename file
  [blog] Announce CNCF Sandbox (#2568)
  document cleaning - tutorial quickstarts (#2520)
  Simplify codecov flag names
  chore(scaffolder-backend): typo in visibility
  Kubernetes plugins boilerplate (#2559)
  CHANGELOG: add entry for SessionApi refactor
  Upload package specific code coverage to codecov
  Add codecov flags for core and core-api packages
  TechDocs: Enable allowVulnerableTags in sanitize-html (#2554)
  chore: trust the Boolean :)
  docs: regenerate api reference docs
  core: refactor SessionStateApi to SessionApi with sign-in/out
  ...
2020-09-24 10:54:04 +02:00
blam 37a4a3afd0 chore(deps): updating dependencies for plugin 2020-09-24 10:52:26 +02:00
blam 6c55d38348 v0.1.1-alpha.23 2020-09-23 16:40:49 +02:00
blam 6f70008386 chore(cli): fixing issues with the new dependency 2020-09-21 23:37:35 +02:00
Raghunandan 72235dd51e v0.1.1-alpha.22 2020-09-18 15:14:38 +02:00
Oliver Sand 20353279d7 feat: use title for API type in table
Now that the API definition types are available via an API, we can resolve the remaining TODO comment here.
2020-09-18 11:21:46 +02:00
Andrew Thauer 8e64ca250c feat: add api-docs config ref for widgets 2020-09-17 08:44:27 -04:00
Oliver Sand bcf0f4cc11 feat: rework Api Explorer components
The table in the API explorer now shows details such as tags, owner, and description.
2020-09-17 12:39:20 +02:00
Andrew Thauer 678a9c90de feat: add graphql api type 2020-09-13 22:01:11 -04:00
Oliver Sand 6f67809bd3 feat: allow to view the raw API definitions, even if a viewer component is available 2020-09-10 17:55:54 +02:00
Fredrik Adelöw 0a24df743f chore: bump mui to the create-app resolved version, to lose Accordion warnings 2020-09-09 11:18:18 +02:00
Dominik Henneke a93450d55f feat(api-docs): move the api-tab from the catalog to the plugin and register it in the default app 2020-09-04 14:14:50 +02:00
Dominik Henneke 8df712b75c fix(api-docs): resolve style warnings 2020-09-04 14:13:29 +02:00
Dominik Henneke d1e281c50d refactor(api-docs): update imports 2020-09-04 14:13:28 +02:00
Emma Indal 3b545791ce new release 31 aug 20 2020-09-01 14:10:22 +02:00
Andrew Thauer 7a5cf65ef3 feat: syntax highlighing for api-docs (#2170) 2020-08-31 08:27:29 +02:00
Oliver Sand e64411a754 fix(api-docs): fix a small styling issue in openapi rendering (#2141)
Specs without operations were no correctly displayed in dark mode.
2020-08-27 15:10:39 +02:00
Raghunandan 734dcca107 Release v0.1.1-alpha.20 2020-08-26 11:33:14 +02:00
Sebastian Qvarfordt 4665a2f5d4 Added selectedTabId param to generatePath in JobStatusModal (#2109)
* Added selectedTabId param to generatePath in JobStatusModal

* Added selectedTabId to generatePath in ApiCatalogTable

* Link to default entity tab in JobStatusModal
2020-08-25 13:57:57 +02:00
Raghunandan 15e334a584 Release v0.1.1-alpha.19 2020-08-21 11:40:04 +02:00
Oliver Sand 95596b8129 chore(api-docs): the api docs plugin should be published (#2051)
* chore(api-docs): the api docs plugin should be published

* chore: add missing @types/react dependency

* chore: move to dependency
2020-08-20 21:01:13 +02: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
Oliver Sand deb108d986 Add styling (especially dark mode) for the asyncAPI display component (#1958) 2020-08-16 15:19:40 +02:00
Oliver Sand c74c8b4592 Improve styling of OpenAPI component (especially in dark mode) (#1961) 2020-08-16 09:10:28 +02:00
Dominik Henneke f809238e61 Update @types/swagger-ui-react 2020-08-13 08:30:44 +02:00
Dominik Henneke 237595f3b4 fix(api-docs): improve the styling of the asyncapi documentation in dark mode 2020-08-12 13:58:49 +02:00
Dominik Henneke 5a023c3c49 feat(api-docs): render documentation of type asyncapi 2020-08-12 13:58:48 +02:00
Dominik Henneke 3534c0804c feat(api-docs): add routes to display all api entities 2020-08-12 13:57:02 +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