Files

T

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

dev

Show a "Refresh" button to if the content is stale

2021-07-05 15:07:08 +02:00

src

Implement in-context search bar for tech docs. (#6651 )

2021-08-27 12:21:48 +02:00

.eslintrc.js

feat(techdocs): yarn create-plugin

2020-06-22 13:42:42 +02:00

api-report.md

Implement in-context search bar for tech docs. (#6651 )

2021-08-27 12:21:48 +02:00

CHANGELOG.md

Version Packages

2021-08-26 11:25:27 +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

Implement in-context search bar for tech docs. (#6651 )

2021-08-27 12:21:48 +02:00

README.md

Update README of all three techdocs packages/plugins

2020-12-05 18:07:50 +01:00

README.md

TechDocs Plugin

Getting started

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

Configuration

http://backstage.io/docs/features/techdocs/configuration

TechDocs Storage Api

The default setup of TechDocs assumes your documentation is accessed by reading a page with the format of <storageUrl>/<entity kind>/<entity namespace>/<entity name>. If for some reason you want to change this it can be configured by implementing a new techdocs storage API. Do this by implementing TechDocsStorage found in plugins/techdocs/src/api. Add your new API to the application in app/src/apis.ts (or replace if it's already registered as an API).