Commit Graph

137 Commits

Author SHA1 Message Date
Elliot Greenwood 04b2ecd23c Add link to owner from the techdocs header
Signed-off-by: Elliot Greenwood <hello@elliotgreenwood.co.uk>
2021-02-23 23:56:23 +00:00
Elliot Greenwood 9a03faa997 Add namespace to the component links in the techdocs header
Signed-off-by: Elliot Greenwood <hello@elliotgreenwood.co.uk>
2021-02-23 23:56:23 +00:00
Adam Harvey 6f90b912fc Merge branch 'master' of github.com:backstage/backstage into improve-errors 2021-02-08 11:48:19 -05:00
Adam Harvey d84cb8199d Switch to CodeSnippet component 2021-02-08 10:54:48 -05:00
Adam Harvey 59b1b04f0b Merge pull request #4314 from adamdmharvey/techdocs-error500
techdocs: Expose backend 500 errors (mkdocs build) to UI
2021-02-05 12:26:52 -05:00
Adam Harvey fd933c4239 Add comment TODO 2021-02-05 10:50:11 -05:00
Patrik Oldsberg 41af18227f techdocs: migrate to new composability API 2021-02-04 20:22:50 +01:00
Adam Harvey e73f35b1ea Wrap in code fence 2021-02-03 21:46:54 -05:00
Oliver Sand 5fa3bdb553 Add support for links in ItemCard and fix height of cards with tags vs cards without tags 2021-02-03 09:37:52 +01:00
Adam Harvey 2b9d16b397 Add period for consistency in error msg 2021-02-02 23:32:06 -05:00
Adam Harvey 5479e4eef0 Improve display of errors 2021-02-02 23:27:20 -05:00
Himanshu Mishra 1df7721a68 TechDocs: Fix test with invalid hook call error 2021-02-02 13:52:47 +01:00
Himanshu Mishra 4ddf8d5e27 TechDocs: Fix frontend tests due to async apiOrigin function 2021-02-02 13:52:47 +01:00
Parth Shandilya e44925723e TechDocs: Make requestUrl and storageUrl optional configs by using discovery APIs
closes #3715

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-02 13:51:04 +01:00
Adam Harvey 96dbdfbb41 Update error message 2021-01-31 22:02:25 -05:00
Adam Harvey 45de779d5f Add changeset 2021-01-29 16:20:07 -05:00
Adam Harvey cb61bc8cbb Hardcode file not found status 2021-01-29 16:16:14 -05:00
Adam Harvey 877f46c177 Support custom status codes 2021-01-29 16:15:34 -05:00
Oliver Sand c677643afa Rename from @backstage/plugin-catalog-common-react to @backstage/plugin-catalog-react 2021-01-29 10:54:09 +01:00
Oliver Sand 019fe39a08 Createa @backstage/plugin-catalog-common-react package 2021-01-29 10:54:09 +01:00
Matei David a5e27d5c1d Introduce techdocs metadata in techdocs-common
* Add TechdocsMetadata type in backend plugin endpoint
 * Introduce TechDocsMetadata type in frontend
 * Add changeset
 * Remove old thennable metadata resp
 * Address PR feedback
  - Remove explicit type annotation on TechDocsMetadata
  - Reintroduce res.send instead of throwing an error
  - Change logger info to logger error
 * Add TechDocsMetadata type in frontend plugin
 * Commit yarn.lock
 * Introduce JSON5 and remove parsing in local pub
Signed-off-by: Matei David <matei.david.35@gmail.com>
2021-01-16 18:33:53 +00:00
Fredrik Adelöw a6f9dca0dc plugins should not depend on core-api 2021-01-14 08:54:54 +01:00
Kevin Lee 99a778ac9f Use history.pushState for hash link navigation in techdocs 2021-01-13 23:21:34 +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
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 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 85af34ffd5 techdocs: Use EntityName from catalog-model as Entity type 2020-11-28 20:02:40 +01: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
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
Fredrik Adelöw 717e43de14 catalog-client: change entities interface, add fields support (#3296) 2020-11-18 19:58:36 +01:00
Fredrik Adelöw 42b0dbddcb feat(catalog-client): create a basic catalog client (#3166) 2020-11-04 13:18:03 +01:00
Vividh Chandna e29ffbe411 fix(TechDocs): Fix broken page title while fetching metadata 2020-10-27 16:53:27 +05:30
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 101978963d Merge branch 'master' of github.com:spotify/backstage into migrate-to-msw
* 'master' of github.com:spotify/backstage: (139 commits)
  Cleanup
  Update PinButton.test.tsx
  feat: update github insights plugin version (#2973)
  Ignore IntelliJ *.iml files (#2971)
  chore(deps): bump rollup-plugin-dts from 1.4.11 to 1.4.13
  fix the plugin card on plugins page
  align 'Add to Marketplace' button on plugins page
  fix the PluginGrid on mobiles sizes
  use getBy query instead of queryBy when asserting for elements present in document (#2951)
  Update PinButton.tsx
  Add test case for Progress component (#2953)
  fix the styling of footer copy on mobile
  add changeset
  handle the case where no entities are available to show
  core-api: work around issue with ApiRef export const declarations
  core-api: move utility api system implementation into apis/system
  Update docs regarding npm config ignore-scripts flag
  Another try
  Fix Core Features configuration id (#2948)
  Fix test?
  ...
2020-10-19 23:57:40 +02:00
Abhishek Jakhar 782f3b3541 Add test case for Progress component (#2953)
* remove data-testid from div

* add test case for Progress component

* add changeset

* update the GraphiQLPage test cases to handle Progress timeout

* update the RadarComponent and RadarPage test case to handle Progress timeout

* update the TechDocsProgressBar test case to handle Progress timeout

* add changeset
2020-10-19 10:33:30 +02:00
Patrik Oldsberg 5ff5b1325d Merge pull request #2739 from Marvin9/feat/flexible-theme-for-page
feat: theme customization for pages
2020-10-16 12:47:05 +02:00
Marvin9 8f0608a5ed chore: refactor 2020-10-15 09:16:39 +05:30
Eric Nilsson 08f5e0311f TechDocsPageHeader: Changed repo location icon (#2895) 2020-10-14 11:03:41 +02:00
blam e44cb85b22 Merge branch 'master' of github.com:spotify/backstage into migrate-to-msw
* 'master' of github.com:spotify/backstage: (66 commits)
  chore: fix lerna linting
  v0.1.1-alpha.25
  Add Code Insights plugin to sample app and marketplace (#2833)
  Improve main CI build status badge in README (#2866)
  Update roadmap: Design System 🚢 (#2858)
  github/codecov: switch to informational mode
  github/workflows: use the tip of master as the base for comparing PR code coverage
  make saml provider path from globalConfig (#2855)
  fix(catalog-backend): limit search value lengths
  Update project Copyright (#2852)
  fix(catalog-backend): actually use modified entity output (default namespace was broken)
  remove unnecessary center keyword
  Move card header bg to up contrast, fix #2558
  Update name of env authentication env vars
  Fix feedback from dtuite
  Remove chart testing workflow for now
  Only lint charts on Pull Requests
  Move the k8s deployment docs to its own helm deployment page
  Remove line in initdb script that creates backend db
  Use app-config.development.yaml to provide configuration instead of local
  ...
2020-10-13 03:56:13 +02:00
Marvin9 6e3ba7c2c4 chore: resolve conflicts 2020-10-11 19:19:35 +05:30
Marvin9 6d68f6fec1 feat: consume theme provided by Page theme provider 2020-10-11 19:14:23 +05:30
Stefan Ålund 8d666e43bd Use MissingAnnotationEmptyState for plugins (#2824) 2020-10-09 15:11:15 +02:00