Commit Graph

177 Commits

Author SHA1 Message Date
Eric Peterson 47037a2197 Merge pull request #5477 from SDA-SE/feat/techdocs-flicker2
TechDocs: Rework state management to avoid rendering multiple while navigating between pages
2021-04-26 18:57:42 +02:00
Oliver Sand cb8c848a38 Disable color transitions on links to avoid issues in dark mode
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-04-26 17:17:10 +02:00
Oliver Sand 17915e29b3 Rework state management to avoid rendering multiple while navigating between pages
Closes #5184

Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-04-26 16:59:14 +02:00
Oliver Sand 35e32bbf4c Merge pull request #5425 from SDA-SE/feat/techdocssss-api
TechDocs: Use interface and not implementation in ApiRef<T>
2021-04-26 14:21:58 +02:00
Chongyang Adrian, Ke 15cbe68156 fix techdocs landing page table wrong copied link
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-26 12:02:44 +08:00
Oliver Sand a3048a3b7f Fix some remaining typing issues
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-04-23 12:48:14 +02:00
Oliver Sand f09f6a166b Use interface and not implementation in ApiRef<T>
Closes #4404

Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-04-23 12:48:13 +02:00
Eric Peterson 74a5b00eb6 Merge pull request #5371 from adrianke77/techdocs-landing-page-customization
Add TechDocs landing page customization and exported components
2021-04-23 11:50:15 +02:00
Chongyang Adrian, Ke 813a4a04f5 fix DocsTable rendering of EmptyState
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:38:09 +08:00
Chongyang Adrian, Ke 7dd94b0750 add CSSProperties type for panelCSS
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:20:46 +08:00
Adrian Ke Chongyang 4666ddb275 Update plugins/techdocs/src/home/components/TechDocsHome.tsx
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:18 +08:00
Adrian Ke Chongyang 64ade20227 Update plugins/techdocs/src/home/components/TechDocsHome.tsx
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:18 +08:00
Chongyang Adrian, Ke cb321bae90 change naming from widget to panel
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:18 +08:00
Chongyang Adrian, Ke 39bdaa0046 Add TechDocs landing page customization and exported components
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-23 11:07:17 +08:00
Oliver Sand 23afdba96f Use EntityRefLink in header and use relations to reference the owner of the document
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-04-22 13:26:07 +02:00
Chongyang Adrian, Ke 2b440c0605 add git feedback link: update FAQ and unit testing
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-20 13:43:29 +08:00
Chongyang Adrian, Ke ac6025f63a techdocs-plugin: add feedback link for Github/Gitlab source repos
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-04-20 13:05:04 +08:00
Dominik Henneke e292e393fb Add a test id to the shadow root element of the Reader to access it easily in e2e tests
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-04-15 13:49:06 +02:00
Jonah Grimes fef852ecd3 Reworked TechDocs page subtitle to reflect the company/organization name (#5317)
* reworked page subtitle to reflect the company/organization name instead of 'Backstage'

Signed-off-by: Jonah Grimes <jgrimes@appriss.com>

* ran prettier to reformat code

Signed-off-by: Jonah Grimes <jgrimes@appriss.com>

* marked changeset as techdocs only

Signed-off-by: Jonah Grimes <jgrimes@appriss.com>
2021-04-14 16:45:20 +02:00
David Tuite 18f7345a6c Add borders to docs tables (#5281) 2021-04-12 20:11:35 +02:00
Eric Peterson 6db7ef3f93 Merge pull request #4968 from adrianke77/techdocs-if-outdated-serve-and-start-build
TechDocs: show outdated docs and asnyc build new
2021-03-25 11:15:01 +01:00
Oliver Sand ea9d977e7d Fix icons of admonitions
The fixes one display issue of #3558

Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-03-25 08:45:19 +01:00
Chongyang Adrian, Ke 74e5042386 fix rebase clashes
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-03-25 11:00:04 +08:00
Chongyang Adrian, Ke aaeb7ecf3c TechDocs: show outdated docs and asnyc build new
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-03-25 10:26:11 +08:00
Chongyang Adrian, Ke 3139f83af5 improve small-screen rendering
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-03-24 14:57:51 +08:00
Chongyang Adrian, Ke 8c32fbb8c4 Add sticky sidebars and footer nav in Techdocs Reader
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-03-23 17:37:35 +08:00
Adrian Ke Chongyang 2aab54319e techdocs: reset scroll position on page navigate (#5018)
Signed-off-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>

Co-authored-by: Chongyang Adrian, Ke <ftt.adrian.ke@grabtaxi.com>
2021-03-22 16:42:49 +01:00
Himanshu Mishra 78e1866688 Merge pull request #4894 from tudi2d/4825-techdocs-breadcrumbs 2021-03-15 12:30:41 +01:00
tudi2d 50be5c09aa Add rootRouteRef to test app options to fix component tests
Signed-off-by: tudi2d <phugenroth@googlemail.com>
2021-03-12 15:30:39 +01:00
tudi2d 634577d887 Change hardcoded docs link to use route reference
- Specify Changelog

Signed-off-by: tudi2d <phugenroth@googlemail.com>
2021-03-12 14:54:45 +01:00
tudi2d 5bf51c3db2 Change link to static /docs
Signed-off-by: tudi2d <phugenroth@googlemail.com>
2021-03-12 14:54:41 +01:00
Emma Indal c8b54c3702 TechDocs Homepage (#4401)
* add tabs to homepage

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add new overview content component

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add new owned content component

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add types

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add test for owned content component

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add test for overview content

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* document name to link and change copy to clipboard link

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add changeset

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* rename changeset file

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* fix types

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* move home components out from reader dir to its own dir

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* Update plugins/techdocs/src/reader/components/OverviewContent.tsx

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* enable search in table

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add docs icon to core icons

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add example TechDocs support button config

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* use isOwnerOff and useOwnUser to see documents that are owned via group membership

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* update tests

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* cleanup imports

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* leave techdocs support config out of this PR

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* prettieeeeeer

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* copy paste useOwnUser hook over to techdocs plugin

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* add changeset

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* delete unused package

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-03-11 19:23:32 +01:00
Fredrik Adelöw 702b837b8b Remove all dot-folder imports everywhere
We aren't supposed to import from '.' or '../..' etc; point to the actual node being imported instead. I did allow e.g. '../../bigfolder' however. Going all the way to the individual file could be done too, but is a matter of taste perhaps.

Also ran Organize Imports on all the touched files :)

No changeset since there are no functional changes at all - only the imports changed

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-03-10 13:43:59 +01:00
Himanshu Mishra d661bece6a Merge pull request #4675 from egnwd/techdocs/header-links 2021-03-08 13:21:43 +00:00
Fredrik Adelöw 2089de76be ItemCard: deprecate and replace with composable pieces
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-03-04 19:27:24 +01:00
Elliot Greenwood 83883a2ea3 Update plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
Signed-off-by: Elliot Greenwood <hello@elliotgreenwood.co.uk>
2021-03-02 16:50:05 +00:00
Erik Larsson 52b5bc3e27 Remove credentials from xhr request. Add techdocs-backend changeset 2021-03-01 12:45:18 +01:00
Erik Larsson 74534a0f8c Move auth token to contrib 2021-03-01 12:29:59 +01:00
Erik Larsson afebbadd34 use token instead of idToken 2021-03-01 12:29:59 +01:00
Erik Larsson 813c6a4f20 add authorization to techdocs api requests 2021-03-01 12:29:58 +01:00
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