Commit Graph

222 Commits

Author SHA1 Message Date
Remi 3418938a64 feat(techdocs): update config schema 2020-12-30 10:25:58 +01:00
github-actions[bot] a1ebbdeee0 Version Packages 2020-12-29 10:59:38 +00:00
Himanshu Mishra bd3bc94ff8 Merge pull request #3799 from keshann93/plugins/techdocs 2020-12-28 20:52:53 +01:00
github-actions[bot] c3c04658f2 Version Packages 2020-12-22 12:14:20 +00:00
keshan 851dde45f7 updated the missed attr change 2020-12-21 16:31:01 +05:30
keshan e53d4a2ca8 updated based on the feedbacks provided 2020-12-21 16:26:58 +05:30
keshan 359f9d2d8c Introduced config schema for techdocs plugins 2020-12-21 16:26:57 +05:30
github-actions[bot] 6e9f4d4a15 Version Packages 2020-12-17 10:16:33 +00:00
Himanshu Mishra 15d23c004e Merge remote-tracking branch 'origin/master' into orkohunter/techdocs-publish-to-cloud-storage 2020-12-10 21:12:31 +01:00
github-actions[bot] cf187484bf Version Packages 2020-12-10 11:25:39 +00:00
Himanshu Mishra ac88ca2038 Merge branch 'master' into orkohunter/techdocs-publish-to-cloud-storage 2020-12-09 20:17:06 +01:00
Himanshu Mishra 511f59f021 1. Use $file for googleGcs.credentials
2. Clarify that techdocs-common is only used in backend plugin since it is compiled to commonJS
2020-12-09 20:11:33 +01:00
Himanshu Mishra 24bcdd0829 techdocs: Use googleGcs for publisher type instead of google_gcs 2020-12-09 18:58:12 +01:00
Himanshu Mishra 9d08ef8f46 techdocs: replace 'build' with 'generate' in most places 2020-12-09 16:01:29 +01:00
Himanshu Mishra 9bd130a73a techdocs: Use 'local' and 'external' for alternatives for techdocs.builder config
Co-authored-by: freben <freben@gmail.com>
2020-12-09 12:31:40 +01:00
Adam Harvey 8b395bee26 Add standard NPM metadata 2020-12-08 13:42:23 -05:00
Himanshu Mishra 8736de114a Merge remote-tracking branch 'origin/master' into orkohunter/techdocs-publish-to-cloud-storage 2020-12-08 08:12:38 +01:00
Sebastian Qvarfordt 87a33d2fe8 [TechDocs] Bug fixes and cleanups (#3599)
* Fixed issue with some internal doc links reloading the page and removed modifyCss transformer

* Create silly-kiwis-rest.md

* Formatting in changeset
2020-12-07 16:49:24 +01:00
Himanshu Mishra 372160ede5 Update README of all three techdocs packages/plugins 2020-12-05 18:07:50 +01:00
Himanshu Mishra a212e43142 techdocs: Add JSON Schema config
Show better error if techdocs.builder is set to 'ci' and if no docs are found.
Return 404 from googleStorage client when a file is not found.
2020-12-05 10:48:54 +01:00
Himanshu Mishra 11340fb2f6 techdocs: Remove spinners
Spinners cause unnecessary UX distraction.
Case 1 (when docs are built and are to be served): Spinners appear for a split second before the name of site shows up. This unnecessarily distracts eyes because spinners increase the size of the Header. A dot (.) would do fine. Definitely more can be done.
Case 2 (when docs are being generated): There is already a linear progress bar (which is recommended in Storybook). Spinners are not good. 🤷
2020-12-04 22:09:38 +01:00
Himanshu Mishra f0bfd369b3 Merge remote-tracking branch 'origin/master' into orkohunter/techdocs-publish-to-cloud-storage 2020-12-03 22:53:45 +01:00
github-actions[bot] 01aa774d9a Version Packages 2020-12-03 15:28:22 +00:00
Himanshu Mishra ff348df9fe techdocs-common: Initialize package and move common code from techdocs-backend 2020-12-01 20:48:58 +01:00
Himanshu Mishra 85af34ffd5 techdocs: Use EntityName from catalog-model as Entity type 2020-11-28 20:02:40 +01:00
github-actions[bot] 892645b815 Version Packages 2020-11-27 12:51:09 +00:00
Himanshu Mishra dbca620ff9 Use fs-extra and async file read method 2020-11-26 20:41:40 +01:00
Himanshu Mishra 266e93b478 TechDocs: Refactor metadata retrieval
1. Don't use mkdocs in name of APIs or variables. It is an implementation detail and liable to change in future.
2. techDocsApi.getMetadata('mkdocs') and techDocsAPI.getMetadata('entity') should be two separate functions just because their responses differ in structure. They should also be type checked.
3. Use either 'techdocs' or 'TechDocs' consistently. 'techDocs' seems like an unnecessary third way to write TechDocs, which can be avoided.
4. Remove unused /plugins/techdocs-backend/src/service/metadata.ts file
2020-11-25 19:39:48 +01:00
Himanshu Mishra 8fd5e64351 TechDocs: Tell users when index.md is missing (better error message) (#3429)
* TechDocs: Logger already prints the name of plugin

* TechDocs: Display a custom error message if provided

* TechDocs: throw custom error message if index.md is not present

* Language improvements. Thanks @freben

Co-authored-by: Fredrik Adelöw <freben@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2020-11-25 09:52:19 +01:00
github-actions[bot] 7d564164fd Version Packages 2020-11-24 13:34:37 +00:00
Himanshu Mishra 1d55b1e976 Merge pull request #3336 from backstage/mob/techdocs-storage-solutions-spec 2020-11-24 14:30:42 +01:00
Himanshu Mishra 8fc3fc9629 TechDocs: Document basic and recommended architecture 2020-11-23 17:41:58 +01:00
github-actions[bot] bc0f47b7b7 Version Packages 2020-11-19 15:13:57 +00:00
Fredrik Adelöw 717e43de14 catalog-client: change entities interface, add fields support (#3296) 2020-11-18 19:58:36 +01:00
Patrik Oldsberg 9621ef3a96 techdocs: add storageUrl to config schema
Co-authored-by: Sebastian Qvarfordt <s.qvarfordt@gmail.com>
2020-11-18 11:31:18 +01:00
Patrik Oldsberg feb9905a37 plugins: add config schema needed by frontend plugins 2020-11-18 11:31:15 +01:00
Patrik Oldsberg 05ae2a4e52 cli: remove plugin:export 2020-11-16 13:17:35 +01:00
github-actions[bot] 76a8099029 Version Packages 2020-11-12 10:52:23 +00:00
Fredrik Adelöw 42b0dbddcb feat(catalog-client): create a basic catalog client (#3166) 2020-11-04 13:18:03 +01:00
github-actions[bot] 715bb76fb5 Version Packages 2020-11-03 20:50:42 +00:00
Patrik Oldsberg 8360d9f7e2 Merge pull request #3140 from backstage/rugvip/release
Release v0.1.1
2020-11-03 13:28:03 +01:00
Himanshu Mishra 5e8a88bc9a Merge pull request #3126 from vividh/fix/techdocs-page-title 2020-10-28 15:03:37 +01:00
Patrik Oldsberg 833a652d05 v0.1.1 2020-10-28 10:22:09 +01:00
Vividh Chandna e29ffbe411 fix(TechDocs): Fix broken page title while fetching metadata 2020-10-27 16:53:27 +05:30
Patrik Oldsberg ab44512727 fix unbumped packages and bump changelog 2020-10-27 12:02:49 +01:00
Patrik Oldsberg 754109ee61 v0.1.1-alpha.26 2020-10-27 12:00:01 +01:00
canut 8de84c77fc Remove MkDocs copyright from documentation pages (#3072)
* Simplify MkDocs footer in documentation pages

* Update plugins/techdocs/src/reader/transformers/simplifyMkdocsFooter.ts

Co-authored-by: Emma Indal <emma.indahl@gmail.com>

Co-authored-by: Emma Indal <emma.indahl@gmail.com>
2020-10-26 11:56:10 +01:00
blam 1bc1c3af06 Merge branch 'master' of github.com:spotify/backstage into migrate-to-msw
* 'master' of github.com:spotify/backstage:
  Read git auth token from backend config (#2992)
  chore(catalog-model): add the petstore into the default entities
  chore(deps-dev): bump @storybook/addon-actions from 6.0.21 to 6.0.26
  chore(deps): bump eslint-config-prettier from 6.10.0 to 6.14.0
  Add API docs link to About card
  adds a sample organization set of users and groups (#2963)
  Make sure hasCostsWithinTimeframe is a boolean
  fix(catalog-backend): fix codeowners processor to handle users
  feat(catalog): add simple client side paging
  default to last 30 days
  Removed default-branch library since it's no longer used (#3019)
  useRealTimers in  onCssReady test case
  move type dependecy
  remove unused import
  changeset
  simpler query params
2020-10-22 11:02:32 +02:00
Abhishek Jakhar 53f9d70658 useRealTimers in onCssReady test case 2020-10-21 15:43:02 +05:30
blam 84c64329ea chore: fixing dependencies list 2020-10-21 10:36:36 +02:00