Files
backstage/plugins/techdocs
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
..
2021-03-01 12:29:59 +01:00
2021-03-11 19:23:32 +01:00
2021-03-11 13:45:44 +01:00
2021-03-11 13:45:44 +01:00

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).