0.11.15 • Published 3 years ago

@backstage/techdocs-common v0.11.15

Weekly downloads
6,927
License
Apache-2.0
Repository
github
Last release
3 years ago

@backstage/techdocs-common

Common 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 github: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).

@backstage/plugin-techdocs-node
@everything-registry/sub-chunk-109
0.0.0-nightly-20220612024701

3 years ago

0.0.0-nightly-20220604023645

3 years ago

0.0.0-nightly-20220601025619

3 years ago

0.0.0-nightly-20220609024358

3 years ago

0.0.0-nightly-20220608024714

3 years ago

0.0.0-nightly-20220606024253

3 years ago

0.0.0-nightly-20220610024824

3 years ago

0.0.0-nightly-20220611024121

3 years ago

0.0.0-nightly-20220526024803

3 years ago

0.0.0-nightly-20220605024123

3 years ago

0.0.0-nightly-20220602024936

3 years ago

0.11.16-next.0

3 years ago

0.11.16-next.1

3 years ago

0.11.16-next.2

3 years ago

0.0.0-nightly-20220527024541

3 years ago

0.0.0-nightly-20220607024221

3 years ago

0.0.0-nightly-20220613024651

3 years ago

0.0.0-nightly-20220531024457

3 years ago

0.0.0-nightly-20220528023512

3 years ago

0.0.0-nightly-20220525024352

3 years ago

0.0.0-nightly-20220603023939

3 years ago

0.0.0-nightly-20220530025009

3 years ago

0.0.0-nightly-20220529024825

3 years ago

0.0.0-nightly-20220517024505

3 years ago

0.0.0-nightly-20220515024439

3 years ago

0.11.15-next.1

3 years ago

0.11.15-next.0

3 years ago

0.0.0-nightly-20220430024336

3 years ago

0.0.0-nightly-20220511024315

3 years ago

0.0.0-nightly-20220505023756

3 years ago

0.0.0-nightly-20220504024625

3 years ago

0.0.0-nightly-20220510022953

3 years ago

0.0.0-nightly-20220514025553

3 years ago

0.0.0-nightly-20220508024231

3 years ago

0.0.0-nightly-20220509024521

3 years ago

0.0.0-nightly-20220501025208

3 years ago

0.0.0-nightly-20220513024945

3 years ago

0.0.0-nightly-20220428025925

3 years ago

0.11.15

3 years ago

0.0.0-nightly-20220427024951

3 years ago

0.0.0-nightly-20220516023848

3 years ago

0.0.0-nightly-20220503024657

3 years ago

0.0.0-nightly-20220507023751

3 years ago

0.0.0-nightly-20220426024700

3 years ago

0.0.0-nightly-20220429024638

3 years ago

0.0.0-nightly-20220502025029

3 years ago

0.0.0-nightly-20220512024113

3 years ago

0.0.0-nightly-20220506023454

3 years ago

0.0.0-nightly-20220419024359

3 years ago

0.0.0-nightly-20220325022909

3 years ago

0.11.12-next.0

3 years ago

0.0.0-nightly-20220403023234

3 years ago

0.0.0-nightly-20220402023243

3 years ago

0.0.0-nightly-20220414023749

3 years ago

0.0.0-nightly-20220412023410

3 years ago

0.0.0-nightly-20220407023218

3 years ago

0.0.0-nightly-20220404023441

3 years ago

0.0.0-nightly-20220416023406

3 years ago

0.0.0-nightly-20220415024634

3 years ago

0.0.0-nightly-20220330023352

3 years ago

0.0.0-nightly-20220417023605

3 years ago

0.0.0-nightly-20220409023050

3 years ago

0.0.0-nightly-20220316022902

3 years ago

0.0.0-nightly-20220405023238

3 years ago

0.0.0-nightly-20220406023303

3 years ago

0.0.0-nightly-20220408023622

3 years ago

0.0.0-nightly-20220309022441

3 years ago

0.0.0-nightly-20220326022848

3 years ago

0.11.12

3 years ago

0.11.13

3 years ago

0.11.14

3 years ago

0.0.0-nightly-20220329023345

3 years ago

0.0.0-nightly-20220331023254

3 years ago

0.0.0-nightly-20220317022557

3 years ago

0.0.0-nightly-20220327022954

3 years ago

0.0.0-nightly-20220328023349

3 years ago

0.0.0-nightly-20220411023616

3 years ago

0.0.0-nightly-20220418024512

3 years ago

0.11.14-next.1

3 years ago

0.11.14-next.2

3 years ago

0.11.14-next.0

3 years ago

0.0.0-nightly-20220323023253

3 years ago

0.0.0-nightly-20220410023309

3 years ago

0.0.0-nightly-20220413023505

3 years ago

0.0.0-nightly-20220315022536

3 years ago

0.0.0-nightly-20220401024216

3 years ago

0.0.0-nightly-20220310022859

3 years ago

0.0.0-nightly-20220324023116

3 years ago

0.0.0-nightly-20220302023312

3 years ago

0.0.0-nightly-20220301023335

3 years ago

0.0.0-nightly-20220306022754

3 years ago

0.0.0-nightly-20220305022735

3 years ago

0.0.0-nightly-20220227022529

3 years ago

0.0.0-nightly-20220228022605

3 years ago

0.0.0-nightly-20220303023541

3 years ago

0.11.11

3 years ago

0.0.0-nightly-20220308022132

3 years ago

0.0.0-nightly-20220307022304

3 years ago

0.0.0-nightly-20220221022454

3 years ago

0.0.0-nightly-20220209022121

3 years ago

0.0.0-nightly-20220213022110

3 years ago

0.0.0-nightly-2021112622820

3 years ago

0.0.0-nightly-20220723117

3 years ago

0.0.0-nightly-2021112322755

3 years ago

0.0.0-nightly-20220823130

3 years ago

0.0.0-nightly-20220216022224

3 years ago

0.0.0-nightly-202111922557

4 years ago

0.0.0-nightly-202202022734

3 years ago

0.0.0-nightly-20220219022334

3 years ago

0.0.0-nightly-202201323044

3 years ago

0.0.0-nightly-20220203021748

3 years ago

0.0.0-nightly-20220220022427

3 years ago

0.0.0-nightly-20220212022325

3 years ago

0.0.0-nightly-202111722620

4 years ago

0.11.10

3 years ago

0.0.0-nightly-20220210021913

3 years ago

0.0.0-nightly-2021112723138

3 years ago

0.0.0-nightly-20220223022848

3 years ago

0.0.0-nightly-20220217022146

3 years ago

0.11.4-next.0

3 years ago

0.0.0-nightly-20220224022833

3 years ago

0.11.6-next.0

3 years ago

0.0.0-nightly-202201122931

3 years ago

0.0.0-nightly-2021112922954

3 years ago

0.0.0-nightly-20220214021635

3 years ago

0.0.0-nightly-20220923026

3 years ago

0.0.0-nightly-2021113022546

3 years ago

0.11.8

3 years ago

0.11.9

3 years ago

0.11.7-next.0

3 years ago

0.0.0-nightly-2021112522918

3 years ago

0.11.0

4 years ago

0.11.1

3 years ago

0.11.2

3 years ago

0.11.3

3 years ago

0.11.4

3 years ago

0.11.5

3 years ago

0.11.6

3 years ago

0.11.7

3 years ago

0.0.0-nightly-20220623347

3 years ago

0.0.0-nightly-202201921950

3 years ago

0.0.0-nightly-20220215022550

3 years ago

0.0.0-nightly-2021112422718

3 years ago

0.0.0-nightly-20220222022224

3 years ago

0.0.0-nightly-20220218022735

3 years ago

0.0.0-nightly-202111822629

4 years ago

0.0.0-nightly-202111282332

3 years ago

0.0.0-nightly-2021102522541

4 years ago

0.0.0-nightly-2021101322257

4 years ago

0.0.0-nightly-202110822217

4 years ago

0.10.6

4 years ago

0.10.7

4 years ago

0.10.8

4 years ago

0.0.0-nightly-2021102422528

4 years ago

0.0.0-nightly-2021101222132

4 years ago

0.0.0-nightly-2021101022158

4 years ago

0.0.0-nightly-202111222339

4 years ago

0.0.0-nightly-2021102322318

4 years ago

0.0.0-nightly-202110152240

4 years ago

0.0.0-nightly-2021101722431

4 years ago

0.0.0-nightly-202110922220

4 years ago

0.0.0-nightly-20211072262

4 years ago

0.0.0-nightly-2021101122259

4 years ago

0.0.0-nightly-202110162216

4 years ago

0.0.0-nightly-2021101422237

4 years ago

0.0.0-nightly-202110622114

4 years ago

0.0.0-nightly-202110322147

4 years ago

0.0.0-nightly-202110522059

4 years ago

0.10.5

4 years ago

0.0.0-nightly-20211022229

4 years ago

0.0.0-nightly-202110422117

4 years ago

0.0.0-nightly-202110122318

4 years ago

0.0.0-nightly-202192722215

4 years ago

0.0.0-nightly-202193022211

4 years ago

0.0.0-nightly-202192822050

4 years ago

0.0.0-nightly-202193122459

4 years ago

0.0.0-nightly-202192621851

4 years ago

0.0.0-nightly-202192022219

4 years ago

0.0.0-nightly-202191722049

4 years ago

0.0.0-nightly-202191822546

4 years ago

0.10.3

4 years ago

0.10.4

4 years ago

0.0.0-nightly-2021972229

4 years ago

0.0.0-nightly-202191622432

4 years ago

0.0.0-nightly-202191922036

4 years ago

0.0.0-nightly-202192122645

4 years ago

0.0.0-nightly-20219622210

4 years ago

0.10.2

4 years ago

0.0.0-nightly-202183022336

4 years ago

0.10.1

4 years ago

0.0.0-nightly-202181622118

4 years ago

0.0.0-nightly-202181521952

4 years ago

0.0.0-nightly-20218142218

4 years ago

0.0.0-nightly-20218132205

4 years ago

0.0.0-nightly-202181221950

4 years ago

0.0.0-nightly-202181122031

4 years ago

0.0.0-nightly-2021812202

4 years ago

0.10.0

4 years ago

0.0.0-nightly-202173121752

4 years ago

0.0.0-nightly-20218221816

4 years ago

0.0.0-nightly-202173021720

4 years ago

0.0.0-nightly-202172921910

4 years ago

0.0.0-nightly-20217282182

4 years ago

0.0.0-nightly-202172621715

4 years ago

0.0.0-nightly-202172721953

4 years ago

0.9.0

4 years ago

0.8.1

4 years ago

0.0.0-nightly-20217122173

4 years ago

0.0.0-nightly-202171121715

4 years ago

0.8.0

4 years ago

0.0.0-nightly-20217521743

4 years ago

0.0.0-nightly-20217421937

4 years ago

0.7.1

4 years ago

0.0.0-nightly-202162921842

4 years ago

0.7.0

4 years ago

0.0.0-nightly-202162122152

4 years ago

0.0.0-nightly-202162222215

4 years ago

0.0.0-nightly-202162022152

4 years ago

0.0.0-nightly-202161521855

4 years ago

0.6.8

4 years ago

0.0.0-nightly-202161421532

4 years ago

0.0.0-nightly-202161321735

4 years ago

0.6.7

4 years ago

0.0.0-nightly-20216821837

4 years ago

0.0.0-nightly-20216721750

4 years ago

0.0.0-nightly-20216621753

4 years ago

0.0.0-nightly-20216521717

4 years ago

0.0.0-nightly-20216421633

4 years ago

0.0.0-nightly-20216321437

4 years ago

0.6.6

4 years ago

0.0.0-nightly-2021612205

4 years ago

0.0.0-nightly-202153022114

4 years ago

0.0.0-nightly-202152921754

4 years ago

0.6.5

4 years ago

0.0.0-nightly-20215923438

4 years ago

0.0.0-nightly-202142725110

4 years ago

0.0.0-nightly-2021533445

4 years ago

0.0.0-nightly-202151023138

4 years ago

0.0.0-nightly-2021523614

4 years ago

0.6.3

4 years ago

0.6.4

4 years ago

0.0.0-nightly-20214223124

4 years ago

0.0.0-nightly-20214522419

4 years ago

0.0.0-nightly-202142023115

4 years ago

0.0.0-nightly-20214122931

4 years ago

0.0.0-nightly-202132922620

4 years ago

0.0.0-nightly-202132822813

4 years ago

0.0.0-nightly-202132722814

4 years ago

0.5.1

4 years ago

0.0.0-nightly-20214322935

4 years ago

0.0.0-nightly-202141923045

4 years ago

0.0.0-nightly-202141823433

4 years ago

0.0.0-nightly-2021442275

4 years ago

0.0.0-nightly-202141122958

4 years ago

0.0.0-nightly-202141223240

4 years ago

0.0.0-nightly-20214622436

4 years ago

0.6.2

4 years ago

0.6.1

4 years ago

0.6.0

4 years ago

0.5.0

4 years ago

0.0.0-nightly-202121823014

4 years ago

0.4.5

4 years ago

0.0.0-nightly-202121722854

4 years ago

0.0.0-nightly-202121622848

4 years ago

0.0.0-nightly-20212152292

4 years ago

0.0.0-nightly-202121422829

4 years ago

0.0.0-nightly-202121322742

4 years ago

0.0.0-nightly-202121222849

4 years ago

0.4.4

4 years ago

0.0.0-nightly-20212822648

4 years ago

0.0.0-nightly-202121022744

4 years ago

0.0.0-nightly-202121122711

4 years ago

0.0.0-nightly-20212922838

4 years ago

0.0.0-nightly-20212722653

4 years ago

0.0.0-nightly-20212622340

4 years ago

0.0.0-nightly-2021252249

4 years ago

0.0.0-nightly-2021242250

4 years ago

0.4.3

4 years ago

0.0.0-nightly-20212322253

4 years ago

0.0.0-nightly-20212221248

4 years ago

0.0.0-nightly-20212122546

4 years ago

0.0.0-nightly-20211282237

4 years ago

0.0.0-nightly-202112721938

4 years ago

0.0.0-nightly-202112321938

4 years ago

0.4.2

4 years ago

0.0.0-nightly-202112222022

4 years ago

0.0.0-nightly-202112121915

4 years ago

0.0.0-nightly-202112021940

4 years ago

0.4.1

4 years ago

0.0.0-nightly-202111821617

4 years ago

0.0.0-nightly-202111721417

4 years ago

0.0.0-nightly-202111621648

4 years ago

0.0.0-nightly-202111521822

4 years ago

0.0.0-nightly-202111421743

4 years ago

0.0.0-nightly-202111321628

4 years ago

0.4.0

4 years ago

0.0.0-nightly-202111121833

4 years ago

0.3.7

4 years ago

0.0.0-nightly-20211322526

4 years ago

0.0.0-nightly-20211223141

4 years ago

0.0.0-nightly-2021112332

4 years ago

0.0.0-nightly-202103123135

4 years ago

0.0.0-nightly-202103023316

4 years ago

0.0.0-nightly-202102822956

4 years ago

0.3.6

4 years ago

0.0.0-nightly-20210272305

4 years ago

0.0.0-nightly-20210262290

4 years ago

0.3.5

4 years ago

0.0.0-nightly-202102131012

4 years ago

0.0.0-nightly-20210203828

4 years ago

0.0.0-nightly-20210193842

4 years ago

0.0.0-nightly-20210183538

4 years ago

0.3.4

4 years ago

0.0.0-nightly-2021017367

4 years ago

0.0.0-nightly-2021016359

4 years ago

0.0.0-nightly-20210143754

4 years ago

0.3.3

4 years ago

0.0.0-nightly-20210133124

4 years ago

0.0.0-nightly-202101225949

4 years ago

0.0.0-nightly-20210725232

4 years ago

0.3.2

4 years ago

0.0.0-nightly-20210625032

4 years ago

0.0.0-nightly-20210524859

4 years ago

0.0.0-nightly-2021042480

4 years ago

0.0.0-nightly-2021032473

4 years ago

0.0.0-nightly-2021022423

4 years ago

0.0.0-nightly-20210124517

4 years ago

0.0.0-nightly-2020113124333

4 years ago

0.0.0-nightly-2020113023951

4 years ago

0.3.1

4 years ago

0.0.0-nightly-2020112923923

4 years ago

0.3.0

4 years ago

0.0.0-nightly-2020112223434

4 years ago

0.2.0

4 years ago

0.0.0-nightly-202011172224

4 years ago

0.0.0-nightly-2020111622153

4 years ago

0.0.0-nightly-202011152214

4 years ago

0.0.0-nightly-202011142218

5 years ago

0.0.0-nightly-202011132190

5 years ago

0.1.1

5 years ago