0.11.15 • Published 2 years ago

@backstage/techdocs-common v0.11.15

Weekly downloads
6,927
License
Apache-2.0
Repository
github
Last release
2 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

2 years ago

0.0.0-nightly-20220604023645

2 years ago

0.0.0-nightly-20220601025619

2 years ago

0.0.0-nightly-20220609024358

2 years ago

0.0.0-nightly-20220608024714

2 years ago

0.0.0-nightly-20220606024253

2 years ago

0.0.0-nightly-20220610024824

2 years ago

0.0.0-nightly-20220611024121

2 years ago

0.0.0-nightly-20220526024803

2 years ago

0.0.0-nightly-20220605024123

2 years ago

0.0.0-nightly-20220602024936

2 years ago

0.11.16-next.0

2 years ago

0.11.16-next.1

2 years ago

0.11.16-next.2

2 years ago

0.0.0-nightly-20220527024541

2 years ago

0.0.0-nightly-20220607024221

2 years ago

0.0.0-nightly-20220613024651

2 years ago

0.0.0-nightly-20220531024457

2 years ago

0.0.0-nightly-20220528023512

2 years ago

0.0.0-nightly-20220525024352

2 years ago

0.0.0-nightly-20220603023939

2 years ago

0.0.0-nightly-20220530025009

2 years ago

0.0.0-nightly-20220529024825

2 years ago

0.0.0-nightly-20220517024505

2 years ago

0.0.0-nightly-20220515024439

2 years ago

0.11.15-next.1

2 years ago

0.11.15-next.0

2 years ago

0.0.0-nightly-20220430024336

2 years ago

0.0.0-nightly-20220511024315

2 years ago

0.0.0-nightly-20220505023756

2 years ago

0.0.0-nightly-20220504024625

2 years ago

0.0.0-nightly-20220510022953

2 years ago

0.0.0-nightly-20220514025553

2 years ago

0.0.0-nightly-20220508024231

2 years ago

0.0.0-nightly-20220509024521

2 years ago

0.0.0-nightly-20220501025208

2 years ago

0.0.0-nightly-20220513024945

2 years ago

0.0.0-nightly-20220428025925

2 years ago

0.11.15

2 years ago

0.0.0-nightly-20220427024951

2 years ago

0.0.0-nightly-20220516023848

2 years ago

0.0.0-nightly-20220503024657

2 years ago

0.0.0-nightly-20220507023751

2 years ago

0.0.0-nightly-20220426024700

2 years ago

0.0.0-nightly-20220429024638

2 years ago

0.0.0-nightly-20220502025029

2 years ago

0.0.0-nightly-20220512024113

2 years ago

0.0.0-nightly-20220506023454

2 years ago

0.0.0-nightly-20220419024359

2 years ago

0.0.0-nightly-20220325022909

2 years ago

0.11.12-next.0

2 years ago

0.0.0-nightly-20220403023234

2 years ago

0.0.0-nightly-20220402023243

2 years ago

0.0.0-nightly-20220414023749

2 years ago

0.0.0-nightly-20220412023410

2 years ago

0.0.0-nightly-20220407023218

2 years ago

0.0.0-nightly-20220404023441

2 years ago

0.0.0-nightly-20220416023406

2 years ago

0.0.0-nightly-20220415024634

2 years ago

0.0.0-nightly-20220330023352

2 years ago

0.0.0-nightly-20220417023605

2 years ago

0.0.0-nightly-20220409023050

2 years ago

0.0.0-nightly-20220316022902

2 years ago

0.0.0-nightly-20220405023238

2 years ago

0.0.0-nightly-20220406023303

2 years ago

0.0.0-nightly-20220408023622

2 years ago

0.0.0-nightly-20220309022441

2 years ago

0.0.0-nightly-20220326022848

2 years ago

0.11.12

2 years ago

0.11.13

2 years ago

0.11.14

2 years ago

0.0.0-nightly-20220329023345

2 years ago

0.0.0-nightly-20220331023254

2 years ago

0.0.0-nightly-20220317022557

2 years ago

0.0.0-nightly-20220327022954

2 years ago

0.0.0-nightly-20220328023349

2 years ago

0.0.0-nightly-20220411023616

2 years ago

0.0.0-nightly-20220418024512

2 years ago

0.11.14-next.1

2 years ago

0.11.14-next.2

2 years ago

0.11.14-next.0

2 years ago

0.0.0-nightly-20220323023253

2 years ago

0.0.0-nightly-20220410023309

2 years ago

0.0.0-nightly-20220413023505

2 years ago

0.0.0-nightly-20220315022536

2 years ago

0.0.0-nightly-20220401024216

2 years ago

0.0.0-nightly-20220310022859

2 years ago

0.0.0-nightly-20220324023116

2 years ago

0.0.0-nightly-20220302023312

2 years ago

0.0.0-nightly-20220301023335

2 years ago

0.0.0-nightly-20220306022754

2 years ago

0.0.0-nightly-20220305022735

2 years ago

0.0.0-nightly-20220227022529

2 years ago

0.0.0-nightly-20220228022605

2 years ago

0.0.0-nightly-20220303023541

2 years ago

0.11.11

2 years ago

0.0.0-nightly-20220308022132

2 years ago

0.0.0-nightly-20220307022304

2 years ago

0.0.0-nightly-20220221022454

2 years ago

0.0.0-nightly-20220209022121

2 years ago

0.0.0-nightly-20220213022110

2 years ago

0.0.0-nightly-2021112622820

2 years ago

0.0.0-nightly-20220723117

2 years ago

0.0.0-nightly-2021112322755

2 years ago

0.0.0-nightly-20220823130

2 years ago

0.0.0-nightly-20220216022224

2 years ago

0.0.0-nightly-202111922557

2 years ago

0.0.0-nightly-202202022734

2 years ago

0.0.0-nightly-20220219022334

2 years ago

0.0.0-nightly-202201323044

2 years ago

0.0.0-nightly-20220203021748

2 years ago

0.0.0-nightly-20220220022427

2 years ago

0.0.0-nightly-20220212022325

2 years ago

0.0.0-nightly-202111722620

2 years ago

0.11.10

2 years ago

0.0.0-nightly-20220210021913

2 years ago

0.0.0-nightly-2021112723138

2 years ago

0.0.0-nightly-20220223022848

2 years ago

0.0.0-nightly-20220217022146

2 years ago

0.11.4-next.0

2 years ago

0.0.0-nightly-20220224022833

2 years ago

0.11.6-next.0

2 years ago

0.0.0-nightly-202201122931

2 years ago

0.0.0-nightly-2021112922954

2 years ago

0.0.0-nightly-20220214021635

2 years ago

0.0.0-nightly-20220923026

2 years ago

0.0.0-nightly-2021113022546

2 years ago

0.11.8

2 years ago

0.11.9

2 years ago

0.11.7-next.0

2 years ago

0.0.0-nightly-2021112522918

2 years ago

0.11.0

2 years ago

0.11.1

2 years ago

0.11.2

2 years ago

0.11.3

2 years ago

0.11.4

2 years ago

0.11.5

2 years ago

0.11.6

2 years ago

0.11.7

2 years ago

0.0.0-nightly-20220623347

2 years ago

0.0.0-nightly-202201921950

2 years ago

0.0.0-nightly-20220215022550

2 years ago

0.0.0-nightly-2021112422718

2 years ago

0.0.0-nightly-20220222022224

2 years ago

0.0.0-nightly-20220218022735

2 years ago

0.0.0-nightly-202111822629

2 years ago

0.0.0-nightly-202111282332

2 years ago

0.0.0-nightly-2021102522541

2 years ago

0.0.0-nightly-2021101322257

2 years ago

0.0.0-nightly-202110822217

3 years ago

0.10.6

2 years ago

0.10.7

2 years ago

0.10.8

2 years ago

0.0.0-nightly-2021102422528

2 years ago

0.0.0-nightly-2021101222132

2 years ago

0.0.0-nightly-2021101022158

2 years ago

0.0.0-nightly-202111222339

2 years ago

0.0.0-nightly-2021102322318

2 years ago

0.0.0-nightly-202110152240

2 years ago

0.0.0-nightly-2021101722431

2 years ago

0.0.0-nightly-202110922220

3 years ago

0.0.0-nightly-20211072262

3 years ago

0.0.0-nightly-2021101122259

2 years ago

0.0.0-nightly-202110162216

2 years ago

0.0.0-nightly-2021101422237

2 years ago

0.0.0-nightly-202110622114

3 years ago

0.0.0-nightly-202110322147

3 years ago

0.0.0-nightly-202110522059

3 years ago

0.10.5

3 years ago

0.0.0-nightly-20211022229

3 years ago

0.0.0-nightly-202110422117

3 years ago

0.0.0-nightly-202110122318

3 years ago

0.0.0-nightly-202192722215

3 years ago

0.0.0-nightly-202193022211

3 years ago

0.0.0-nightly-202192822050

3 years ago

0.0.0-nightly-202193122459

3 years ago

0.0.0-nightly-202192621851

3 years ago

0.0.0-nightly-202192022219

3 years ago

0.0.0-nightly-202191722049

3 years ago

0.0.0-nightly-202191822546

3 years ago

0.10.3

3 years ago

0.10.4

3 years ago

0.0.0-nightly-2021972229

3 years ago

0.0.0-nightly-202191622432

3 years ago

0.0.0-nightly-202191922036

3 years ago

0.0.0-nightly-202192122645

3 years ago

0.0.0-nightly-20219622210

3 years ago

0.10.2

3 years ago

0.0.0-nightly-202183022336

3 years ago

0.10.1

3 years ago

0.0.0-nightly-202181622118

3 years ago

0.0.0-nightly-202181521952

3 years ago

0.0.0-nightly-20218142218

3 years ago

0.0.0-nightly-20218132205

3 years ago

0.0.0-nightly-202181221950

3 years ago

0.0.0-nightly-202181122031

3 years ago

0.0.0-nightly-2021812202

3 years ago

0.10.0

3 years ago

0.0.0-nightly-202173121752

3 years ago

0.0.0-nightly-20218221816

3 years ago

0.0.0-nightly-202173021720

3 years ago

0.0.0-nightly-202172921910

3 years ago

0.0.0-nightly-20217282182

3 years ago

0.0.0-nightly-202172621715

3 years ago

0.0.0-nightly-202172721953

3 years ago

0.9.0

3 years ago

0.8.1

3 years ago

0.0.0-nightly-20217122173

3 years ago

0.0.0-nightly-202171121715

3 years ago

0.8.0

3 years ago

0.0.0-nightly-20217521743

3 years ago

0.0.0-nightly-20217421937

3 years ago

0.7.1

3 years ago

0.0.0-nightly-202162921842

3 years ago

0.7.0

3 years ago

0.0.0-nightly-202162122152

3 years ago

0.0.0-nightly-202162222215

3 years ago

0.0.0-nightly-202162022152

3 years ago

0.0.0-nightly-202161521855

3 years ago

0.6.8

3 years ago

0.0.0-nightly-202161421532

3 years ago

0.0.0-nightly-202161321735

3 years ago

0.6.7

3 years ago

0.0.0-nightly-20216821837

3 years ago

0.0.0-nightly-20216721750

3 years ago

0.0.0-nightly-20216621753

3 years ago

0.0.0-nightly-20216521717

3 years ago

0.0.0-nightly-20216421633

3 years ago

0.0.0-nightly-20216321437

3 years ago

0.6.6

3 years ago

0.0.0-nightly-2021612205

3 years ago

0.0.0-nightly-202153022114

3 years ago

0.0.0-nightly-202152921754

3 years ago

0.6.5

3 years ago

0.0.0-nightly-20215923438

3 years ago

0.0.0-nightly-202142725110

3 years ago

0.0.0-nightly-2021533445

3 years ago

0.0.0-nightly-202151023138

3 years ago

0.0.0-nightly-2021523614

3 years ago

0.6.3

3 years ago

0.6.4

3 years ago

0.0.0-nightly-20214223124

3 years ago

0.0.0-nightly-20214522419

3 years ago

0.0.0-nightly-202142023115

3 years ago

0.0.0-nightly-20214122931

3 years ago

0.0.0-nightly-202132922620

3 years ago

0.0.0-nightly-202132822813

3 years ago

0.0.0-nightly-202132722814

3 years ago

0.5.1

3 years ago

0.0.0-nightly-20214322935

3 years ago

0.0.0-nightly-202141923045

3 years ago

0.0.0-nightly-202141823433

3 years ago

0.0.0-nightly-2021442275

3 years ago

0.0.0-nightly-202141122958

3 years ago

0.0.0-nightly-202141223240

3 years ago

0.0.0-nightly-20214622436

3 years ago

0.6.2

3 years ago

0.6.1

3 years ago

0.6.0

3 years ago

0.5.0

3 years ago

0.0.0-nightly-202121823014

3 years ago

0.4.5

3 years ago

0.0.0-nightly-202121722854

3 years ago

0.0.0-nightly-202121622848

3 years ago

0.0.0-nightly-20212152292

3 years ago

0.0.0-nightly-202121422829

3 years ago

0.0.0-nightly-202121322742

3 years ago

0.0.0-nightly-202121222849

3 years ago

0.4.4

3 years ago

0.0.0-nightly-20212822648

3 years ago

0.0.0-nightly-202121022744

3 years ago

0.0.0-nightly-202121122711

3 years ago

0.0.0-nightly-20212922838

3 years ago

0.0.0-nightly-20212722653

3 years ago

0.0.0-nightly-20212622340

3 years ago

0.0.0-nightly-2021252249

3 years ago

0.0.0-nightly-2021242250

3 years ago

0.4.3

3 years ago

0.0.0-nightly-20212322253

3 years ago

0.0.0-nightly-20212221248

3 years ago

0.0.0-nightly-20212122546

3 years ago

0.0.0-nightly-20211282237

3 years ago

0.0.0-nightly-202112721938

3 years ago

0.0.0-nightly-202112321938

3 years ago

0.4.2

3 years ago

0.0.0-nightly-202112222022

3 years ago

0.0.0-nightly-202112121915

3 years ago

0.0.0-nightly-202112021940

3 years ago

0.4.1

3 years ago

0.0.0-nightly-202111821617

3 years ago

0.0.0-nightly-202111721417

3 years ago

0.0.0-nightly-202111621648

3 years ago

0.0.0-nightly-202111521822

3 years ago

0.0.0-nightly-202111421743

3 years ago

0.0.0-nightly-202111321628

3 years ago

0.4.0

3 years ago

0.0.0-nightly-202111121833

3 years ago

0.3.7

3 years ago

0.0.0-nightly-20211322526

3 years ago

0.0.0-nightly-20211223141

3 years ago

0.0.0-nightly-2021112332

3 years ago

0.0.0-nightly-202103123135

3 years ago

0.0.0-nightly-202103023316

3 years ago

0.0.0-nightly-202102822956

3 years ago

0.3.6

3 years ago

0.0.0-nightly-20210272305

3 years ago

0.0.0-nightly-20210262290

3 years ago

0.3.5

3 years ago

0.0.0-nightly-202102131012

3 years ago

0.0.0-nightly-20210203828

3 years ago

0.0.0-nightly-20210193842

3 years ago

0.0.0-nightly-20210183538

3 years ago

0.3.4

3 years ago

0.0.0-nightly-2021017367

3 years ago

0.0.0-nightly-2021016359

3 years ago

0.0.0-nightly-20210143754

3 years ago

0.3.3

3 years ago

0.0.0-nightly-20210133124

3 years ago

0.0.0-nightly-202101225949

3 years ago

0.0.0-nightly-20210725232

3 years ago

0.3.2

3 years ago

0.0.0-nightly-20210625032

3 years ago

0.0.0-nightly-20210524859

3 years ago

0.0.0-nightly-2021042480

3 years ago

0.0.0-nightly-2021032473

3 years ago

0.0.0-nightly-2021022423

3 years ago

0.0.0-nightly-20210124517

3 years ago

0.0.0-nightly-2020113124333

3 years ago

0.0.0-nightly-2020113023951

3 years ago

0.3.1

3 years ago

0.0.0-nightly-2020112923923

3 years ago

0.3.0

3 years ago

0.0.0-nightly-2020112223434

3 years ago

0.2.0

3 years ago

0.0.0-nightly-202011172224

3 years ago

0.0.0-nightly-2020111622153

3 years ago

0.0.0-nightly-202011152214

3 years ago

0.0.0-nightly-202011142218

3 years ago

0.0.0-nightly-202011132190

3 years ago

0.1.1

3 years ago