Commit Graph

530 Commits

Author SHA1 Message Date
github-actions[bot] 3369ade8c0 Version Packages 2021-11-11 11:07:58 +00:00
Oliver Sand ac511f98c4 Merge pull request #7865 from SDA-SE/feat/api-docs-customization
Lazy load API definition widgets
2021-11-11 12:03:00 +01:00
Kim Jin 53c9ad7e04 Update TechDocs Headings css font weight (#7931)
* update headings style

Signed-off-by: kim5566 <28945404+kim5566@users.noreply.github.com>

* add changeset

Signed-off-by: kim5566 <28945404+kim5566@users.noreply.github.com>

* update changeset

Signed-off-by: kim5566 <28945404+kim5566@users.noreply.github.com>

* rename changeset

Signed-off-by: kim5566 <28945404+kim5566@users.noreply.github.com>
2021-11-11 11:45:40 +01:00
Oliver Sand 7e5bd18cf7 Adjust to review comments
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-11-11 09:55:03 +01:00
Oliver Sand fe5738fe1c Lazy load LazyLog as it is rarely used
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-11-11 09:54:27 +01:00
github-actions[bot] d66c5f1282 Version Packages 2021-10-28 14:06:43 +00:00
Oliver Sand 106a5dc3ad Restore original casing for kind, namespace and name in DefaultTechDocsCollator
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-10-27 14:30:40 +02:00
blam d465f2e0af chore: bump the msw package and remove it from test-utils as it's not even needed
Signed-off-by: blam <ben@blam.sh>
2021-10-26 17:13:49 +02:00
Ben Lambert 6a4e6e3898 Merge pull request #7733 from cmpadden/tech-docs-scroll-restoration
Scroll to Top of TechDocs Reader During Page Navigation
2021-10-25 10:04:04 +02:00
Colton Padden a9a8c6f7c5 Scroll to the top of reader content when primary navigation link is clicked
When navigating between pages using the primary sidebar navigation menu,
scroll to the top of the generated markdown content via
`.scrollIntoView()`.

Signed-off-by: Colton Padden <colton.padden@fastmail.com>
2021-10-21 10:36:59 -04:00
github-actions[bot] bf5090e59d Version Packages 2021-10-21 13:28:13 +00:00
Patrik Oldsberg 4552206702 Merge pull request #7657 from SDA-SE/feat/techdocs-grid
Add `<EntityListDocsGrid>` and extend `<DocsCardGrid>` to display the entity title
2021-10-21 00:35:19 +02:00
Patrik Oldsberg 82a7349d29 Merge pull request #7640 from kuangp/refactor/searchResultTitles
refactor(search): display entity title for result items if defined
2021-10-21 00:21:34 +02:00
Oliver Sand ba5b75ed2f Add <EntityListDocsGrid> and extend <DocsCardGrid> to display the entity title
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-10-18 11:23:28 +02:00
Phil Kuang 177401b571 refactor(search): display entity title for result items if defined
Signed-off-by: Phil Kuang <pkuang@factset.com>
2021-10-15 14:44:50 -04:00
Dominik Henneke cdf8ca6111 Only replace the shadow dom if the content is changed to avoid a flickering UI
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-10-15 17:14:12 +02:00
github-actions[bot] 4c840cebfa Version Packages 2021-10-14 12:45:08 +00:00
Dominik Henneke 8f55fb815b Fix test
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-10-14 12:08:43 +02:00
Dominik Henneke 82fbda923e Introduce a new StarredEntitiesApi that is used in the useStarredEntities hook
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-10-14 12:08:42 +02:00
Camila Belo 76fef740fe [TechDocs] Experimental useTechDocsReaderDom hook (#7476)
* WIP!

Co-authored-by: Camila Belo <camilaibs@gmail.com>
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

* fix: use dom when updating sidebar

Signed-off-by: Camila Belo <camilaibs@gmail.com>

* fix: extract small components and transformers

Signed-off-by: Camila Belo <camilaibs@gmail.com>

* docs: describe the useTechDocsReaderDom

Signed-off-by: Camila Belo <camilaibs@gmail.com>

* docs: update api report

Signed-off-by: Camila Belo <camilaibs@gmail.com>

* docs: make the hook internal

Signed-off-by: Camila Belo <camilaibs@gmail.com>

* fix: remove circular progress from the alert

Signed-off-by: Camila Belo <camilaibs@gmail.com>

* Fix test

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

* Mark new exports as @internal, add a text string to make it easy to find in the future

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

* Changeset

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

* Do not show progress bar during checking; prevent jumpy site on navigation

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

* Combine progress/alert into a state indicator component and clarify vars.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

* fix: documentation state updates

Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>

* fix: use circular progress again

Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>

* docs: update reader exports

Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>

* refactor: using provider instead of HOC

Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>

* refactor: update the changeset file

Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Camila Belo <camilaibs@gmail.com>

Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
2021-10-13 16:15:27 +02:00
github-actions[bot] 97420439e1 Version Packages 2021-10-07 12:17:39 +00:00
Eric Peterson c781f49fc4 Merge pull request #7435 from backstage/codemod/extension-names
Add names to all core extensions provided by plugins
2021-10-05 16:21:43 +02:00
Alex Rybchenko 7c5351791e updated tests
Signed-off-by: Alex Rybchenko <arybchenko@box.com>
2021-10-05 11:31:58 +02:00
Eric Peterson 81a41ec249 Apply extension-names codemod to monorepo.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-10-04 19:29:43 +02:00
github-actions[bot] f67e8ddcec Version Packages 2021-09-30 11:43:05 +00:00
Emma Indal dcd3e1d968 update api report and prop on Reader component in EntityPageDocs
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-30 12:40:48 +02:00
Emma Indal 1f73801d05 replace entityId with entityRef
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-30 12:21:10 +02:00
Eric Peterson 16b5b3d11a Clean up API report, export types.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2021-09-30 10:27:06 +02:00
Emma Indal 5098f4a7c9 use legacy techdocs page as fallback
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 20:06:36 +02:00
Emma Indal 145999f827 bring back not found
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:30:33 +02:00
Emma Indal a1cc051415 export components
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:11:27 +02:00
Emma Indal 776f625b9c TechDocsPage children to be both render function and plain component
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:11:27 +02:00
Emma Indal 0549587ebf TechDocsPage to accept children and withSearch prop
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:10:15 +02:00
Emma Indal 9bf6fe97cb add tests for TechDocsPage with custom header
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-29 19:10:15 +02:00
Patrik Oldsberg cbc0a83184 Merge pull request #5675 from ayshiff/feature/techdocs-e2e
Feature/techdocs e2e
2021-09-29 13:46:13 +02:00
Fredrik Adelöw 92c3d6dc04 Merge pull request #7356 from backstage/dependabot/npm_and_yarn/testing-library/react-hooks-7.0.2
build(deps): bump @testing-library/react-hooks from 3.4.2 to 7.0.2
2021-09-28 15:25:56 +02:00
Fredrik Adelöw f5e6961bc8 slow down there fella
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-09-28 14:09:12 +02:00
Patrik Oldsberg 1c43d2c25c Merge pull request #7331 from johanhammar/fix-copy-documentation-link-to-clipboard
fix(techdocs): fix copy documentation link to clipboard url
2021-09-28 13:21:37 +02:00
dependabot[bot] e5327abaa3 build(deps): bump @testing-library/react-hooks from 3.4.2 to 7.0.2
Bumps [@testing-library/react-hooks](https://github.com/testing-library/react-hooks-testing-library) from 3.4.2 to 7.0.2.
- [Release notes](https://github.com/testing-library/react-hooks-testing-library/releases)
- [Changelog](https://github.com/testing-library/react-hooks-testing-library/blob/main/CHANGELOG.md)
- [Commits](https://github.com/testing-library/react-hooks-testing-library/compare/v3.4.2...v7.0.2)

---
updated-dependencies:
- dependency-name: "@testing-library/react-hooks"
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-09-28 13:01:24 +02:00
Patrik Oldsberg e4ecdb48a2 techdocs: format TechDocsPage
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-28 11:39:31 +02:00
Patrik Oldsberg 174c574311 Merge branch 'master' into feature/techdocs-e2e
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-09-28 11:12:31 +02:00
Bodil Björklund edda769360 Minor text edits
Piggy-backing on this branch to include minor text edits to README.

Signed-off-by: Bodil Björklund <bodilb@spotify.com>
2021-09-27 17:19:54 +02:00
Emma Indal 03d7911ad9 [TechDocs] Add link to how-to guide
Signed-off-by: Emma Indal emma.indahl@gmail.com
Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-09-27 15:49:25 +02:00
Andre Wanlin 4069e3546c Updated API Report
Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
2021-09-26 10:59:23 -05:00
Johan Hammar 3df2e8532b fix(techdocs): fix copy documentation link to clipboard url
Signed-off-by: Johan Hammar <johan.hammar@gmail.com>
2021-09-26 16:31:38 +02:00
Andre Wanlin 0f74a2f479 Add check for TechDocs annotation on entity
Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
2021-09-25 10:11:42 -05:00
github-actions[bot] 6e5b1bda9d Version Packages 2021-09-23 10:01:17 +00:00
Oliver Sand 84e7232eeb Merge pull request #7206 from SDA-SE/feat/techdocs-context-search-breakpoint
Make techdocs context search bar width adjust on smaller screens
2021-09-17 14:55:02 +02:00
github-actions[bot] fff5c48429 Version Packages 2021-09-16 11:41:51 +00:00
Oliver Sand 4d96985088 Merge pull request #7196 from SDA-SE/feat/update-material-lab
Upgrade `@material-ui/lab` to `4.0.0-alpha.57`
2021-09-16 12:29:41 +02:00