Files
backstage/plugins/techdocs-backend
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
..
2020-08-07 18:51:08 +02:00
2021-03-11 13:45:44 +01:00
2021-03-03 11:46:02 +03:00

techdocs-backend

This is the backend part of the techdocs plugin.

Getting Started

This backend plugin can be started in a standalone mode from directly in this package with yarn start. However, it will have limited functionality and that process is most convenient when developing the techdocs backend plugin itself.

To evaluate TechDocs and have a greater amount of functionality available, instead do

# in one terminal window, run this from from the very root of the Backstage project
cd packages/backend
yarn start

What techdocs-backend does

This plugin is the backend part of the techdocs plugin. It provides serving and building of documentation for any entity. To configure various storage providers and building options, see http://backstage.io/docs/features/techdocs/configuration

The techdocs-backend re-exports the techdocs-common package which has the features to prepare, generate and publish docs. The Publishers are also used to fetch the static documentation files and render them in TechDocs.