Files

T

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

dev

replace entityId with entityRef

2021-09-30 12:21:10 +02:00

src

[TechDocs] Experimental useTechDocsReaderDom hook (#7476 )

2021-10-13 16:15:27 +02:00

.eslintrc.js

…

api-report.md

update api report and prop on Reader component in EntityPageDocs

2021-09-30 12:40:48 +02:00

CHANGELOG.md

Version Packages

2021-10-07 12:17:39 +00:00

config.d.ts

Use lower-case links within techdocs plugin; allow legacy behavior with config.

2021-08-10 13:38:07 +02:00

package.json

Version Packages

2021-10-07 12:17:39 +00:00

README.md

Minor text edits

2021-09-27 17:19:54 +02:00

README.md

TechDocs Plugin

Getting started

Set up Backstage and TechDocs by following our guide on Getting Started.

Configuration

Refer to our configuration reference for a complete listing of configuration options.

TechDocs Storage API

The default setup of TechDocs assumes that your documentation is accessed by reading a page with the format of <storageUrl>/<entity kind>/<entity namespace>/<entity name>. This can be configured by implementing a new techdocs storage API.