1.12.3 • Published 14 hours ago

@backstage/plugin-techdocs-node v1.12.3

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
14 hours ago

@backstage/plugin-techdocs-node

Common node.js functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli

This package is used by techdocs-backend to serve docs from different types of publishers (Google GCS, Local, etc.). It is also used to build docs and publish them to storage, by both techdocs-backend and techdocs-cli.

Usage

Create a preparer instance from the preparers available at which takes an Entity instance. Run the docs generator on the prepared directory. Publish the generated directory files to a storage of your choice.

Example:

async () => {
  const preparedDir = await preparer.prepare(entity);

  const parsedLocationAnnotation = getLocationForEntity(entity);
  const { resultDir } = await generator.run({
    directory: preparedDir,
    dockerClient: dockerClient,
    parsedLocationAnnotation,
  });

  await publisher.publish({
    entity: entity,
    directory: resultDir,
  });
};

Features

Currently the build process is split up in these three stages.

  • Preparers
  • Generators
  • Publishers

Preparers read your entity data and creates a working directory with your documentation source code. For example if you have set your backstage.io/techdocs-ref to url:https://github.com/backstage/backstage.git it will clone that repository to a temp folder and pass that on to the generator.

Generators takes the prepared source and runs the techdocs-container on it. It then passes on the output folder of that build to the publisher.

Publishers gets a folder path from the generator and publish it to your storage solution. Read documentation to know more about configuring storage solutions. http://backstage.io/docs/features/techdocs/configuration

Any of these can be extended. We want to extend our support to most of the storage providers (Publishers) and source code host providers (Preparers).

1.12.4-next.2

3 days ago

1.12.4-next.1

10 days ago

1.12.4-next.0

17 days ago

1.12.3

24 days ago

1.12.3-next.1

1 month ago

1.12.3-next.0

1 month ago

1.12.2

1 month ago

1.12.1

2 months ago

1.12.0

2 months ago

1.12.0-next.2

2 months ago

1.11.6-next.1

2 months ago

1.11.5

2 months ago

1.11.5-next.0

2 months ago

1.11.4

3 months ago

1.11.3

3 months ago

1.11.2

3 months ago

1.11.2-next.3

3 months ago

1.11.2-next.2

3 months ago

1.11.2-next.1

3 months ago

1.11.2-next.0

4 months ago

1.11.1

4 months ago

1.11.1-next.2

4 months ago

1.11.1-next.1

4 months ago

1.11.1-next.0

5 months ago

1.11.0

5 months ago

1.11.0-next.3

5 months ago

1.11.0-next.2

5 months ago

1.11.0-next.1

5 months ago

1.10.0-next.2

6 months ago

1.10.0-next.1

6 months ago

1.9.1-next.0

7 months ago

1.7.6

9 months ago

1.7.5

9 months ago

1.7.4

9 months ago

1.9.0-next.2

7 months ago

1.9.0

7 months ago

1.8.2-next.0

8 months ago

1.8.2-next.1

7 months ago

1.7.6-next.0

9 months ago

1.8.2

7 months ago

1.8.1

8 months ago

1.8.0

8 months ago

1.7.3

10 months ago

1.8.0-next.3

8 months ago

1.8.0-next.2

8 months ago

1.8.0-next.1

9 months ago

1.10.0

6 months ago

1.11.0-next.0

6 months ago

1.7.4-next.1

9 months ago

1.7.4-next.0

10 months ago

1.7.4-next.2

9 months ago

1.7.3-next.0

11 months ago

1.7.2

11 months ago

1.7.2-next.2

11 months ago

1.7.1

12 months ago

1.7.2-next.0

12 months ago

1.7.2-next.1

12 months ago

1.7.1-next.1

1 year ago

1.7.0

1 year ago

1.7.1-next.0

1 year ago

1.6.1-next.3

1 year ago

1.6.0

1 year ago

1.5.0

1 year ago

1.6.0-next.2

1 year ago

1.6.0-next.1

1 year ago

1.5.1-next.0

1 year ago

1.6.1-next.2

1 year ago

1.6.1-next.0

1 year ago

1.6.1-next.1

1 year ago

1.4.5

1 year ago

1.4.4

1 year ago

1.4.6-next.0

1 year ago

1.4.4-next.1

1 year ago

1.4.4-next.2

1 year ago

1.4.6-next.2

1 year ago

1.4.6-next.1

1 year ago

1.4.2-next.0

2 years ago

1.4.2-next.1

2 years ago

1.4.3

1 year ago

1.4.2

1 year ago

1.4.1

2 years ago

1.4.4-next.0

1 year ago

1.4.3-next.3

1 year ago

1.4.3-next.2

1 year ago

1.4.3-next.1

1 year ago

1.4.3-next.0

1 year ago

1.4.1-next.1

2 years ago

1.4.1-next.0

2 years ago

1.4.1-next.2

2 years ago

1.4.0-next.1

2 years ago

1.4.0-next.2

2 years ago

1.4.0

2 years ago

1.3.1-next.0

2 years ago

1.2.0

2 years ago

1.2.1-next.0

2 years ago

1.1.2

2 years ago

1.2.0-next.2

2 years ago

1.2.0-next.1

2 years ago

1.2.0-next.3

2 years ago

1.1.2-next.2

2 years ago

1.1.3-next.0

2 years ago

1.1.2-next.0

2 years ago

1.1.2-next.1

2 years ago

1.3.0-next.1

2 years ago

1.3.0

2 years ago

1.1.1

2 years ago

1.1.1-next.1

2 years ago

1.1.1-next.0

2 years ago

1.0.0

2 years ago

0.11.12-next.0

2 years ago

1.0.1-next.1

2 years ago

1.0.1-next.0

2 years ago

1.1.0

2 years ago

1.1.0-next.2

2 years ago

0.11.12

2 years ago