paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 46 Packages Projects Releases Wiki Activity
18,591 Commits 1 Branch 0 Tags
ac4eeb710259b9216c19e48ee5fb3faa7aa7c122
Commit Graph

305 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
Oliver Sand be13dfe61a Make techdocs context search bar width adjust on smaller screens 
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
 2021-09-16 12:23:00 +02:00
Patrik Oldsberg d0d78ebc7c Merge pull request #7181 from backstage/rugvip/descriptions 
Add package descriptions + separate table for plugins in API reference
 2021-09-15 17:25:27 +02:00
Jussi Hallila 9fb0503c15 Tweak lowecasing, export Optios type 
Signed-off-by: Jussi Hallila <jussi@hallila.com>
 2021-09-15 15:31:03 +02:00
Patrik Oldsberg 8142a8ecb2 packages,plugins: add package documentation 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2021-09-14 18:47:53 +02:00
Jussi Hallila 44aac03eb7 Update tech docs search filters to be aware when to use legacy paths and when not. 
Signed-off-by: Jussi Hallila <jussi@hallila.com>
 2021-09-07 15:55:02 +02:00
Ruben Lindström 7f00902d97 Search Bar Home Page Component (#7013) 
feat: add search bar home page component
 2021-09-03 14:50:14 +02:00
Aurelio Saraiva d288ffc77a fixed typo camelcase 
Signed-off-by: Aurelio Saraiva <aureliosaraiva@gmail.com>
 2021-08-31 09:51:07 -03:00
Aurelio Saraiva 37b29bd5a5 Merge branch 'master' into techdoc_title 2021-08-30 18:17:19 -03:00
Jussi Hallila 30ed662a35 Implement in-context search bar for tech docs. (#6651) 
* Implement in-context search bar for tech docs

* Add in-context search functionality to tech docs
* Use the existing backend search functionality with tech docs specific filters
* Use material-ui autocomplete to display 10 first search results
* Add tests

Signed-off-by: Jussi Hallila <jussi@hallila.com>

* Remove context and replace it with `withSearch` prop.

Signed-off-by: Jussi Hallila <jussi@hallila.com>

* Bump search-common devp to latest

Signed-off-by: Jussi Hallila <jussi@hallila.com>

* Rename types file to not conflict with hardcoded types.d.ts.

Signed-off-by: Jussi Hallila <jussi@hallila.com>
 2021-08-27 12:21:48 +02:00
Fredrik Adelöw 3c14f71b08 Merge pull request #6880 from kuangp/fix/feedbackUrl 
fix(techdocs): generate correct feedback urls for GitHub
 2021-08-25 15:26:34 +02:00
Phil Kuang 90c68a2ca8 fix(techdocs): generate correct feedback urls for GitHub 
Signed-off-by: Phil Kuang <pkuang@factset.com>
 2021-08-19 11:12:36 -04:00
Aurelio Saraiva 60169a761d renamed function to customTitle 
Signed-off-by: Aurelio Saraiva <aureliosaraiva@gmail.com>
 2021-08-18 19:34:16 -03:00
Aurelio Saraiva ce02607532 added title 
Signed-off-by: Aurelio Saraiva <aureliosaraiva@gmail.com>
 2021-08-18 19:02:04 -03:00
Eric Peterson 787bc08262 Finish TechDocs migration to composability API. 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-12 14:38:26 +02:00
Eric Peterson 52547371fb Merge branch 'master' into techdocs-common/case-sensitive-migration 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-12 11:27:43 +02:00
Phil Kuang 80582cbec4 feat(techdocs): implement composable home page 
Signed-off-by: Phil Kuang <pkuang@factset.com>
 2021-08-10 10:03:26 -04:00
Phil Kuang 10ef115554 refactor(EntityListDocsTable): support custom columns and actions 
Signed-off-by: Phil Kuang <pkuang@factset.com>
 2021-08-10 10:03:25 -04:00
Phil Kuang a440d3b389 refactor(techdocs): rework TechDocsHome to use EntityListProvider 
Signed-off-by: Phil Kuang <pkuang@factset.com>
 2021-08-10 10:03:24 -04:00
Eric Peterson add5ee5d97 Use lower-case links within techdocs plugin; allow legacy behavior with config. 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
 2021-08-10 13:38:07 +02:00
Patrik Oldsberg 8a3e465910 techdocs: switch to xhr-based event source polyfill 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
 2021-08-10 10:03:01 +02:00