From 156421c59a443a7ab8f50f5c4339bf9bcaf567c4 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 5 Oct 2021 13:57:55 +0200 Subject: [PATCH] [TechDocs] Update default techdocs docker image to latest version (#7448) * set default docker image to latest one 0.3.3 Signed-off-by: Emma Indal * update extensions docs with new truly sane lists example Signed-off-by: Emma Indal * changeset Signed-off-by: Emma Indal * use consistent tagging for docker image versions Signed-off-by: Emma Indal * update changeset with correct link to tag Signed-off-by: Emma Indal * update api report Signed-off-by: Emma Indal --- .changeset/techdocs-chilled-pans-fix.md | 5 +++++ packages/techdocs-common/api-report.md | 2 +- .../src/stages/generate/techdocs.ts | 2 +- .../documented-component/docs/extensions.md | 17 +++++++++++++++++ 4 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 .changeset/techdocs-chilled-pans-fix.md diff --git a/.changeset/techdocs-chilled-pans-fix.md b/.changeset/techdocs-chilled-pans-fix.md new file mode 100644 index 0000000000..dbb1a8279a --- /dev/null +++ b/.changeset/techdocs-chilled-pans-fix.md @@ -0,0 +1,5 @@ +--- +'@backstage/techdocs-common': patch +--- + +Sets the default techdocs docker image to the [latest released version - v0.3.3](https://github.com/backstage/techdocs-container/releases/tag/v0.3.3). diff --git a/packages/techdocs-common/api-report.md b/packages/techdocs-common/api-report.md index 38f4a9aec3..fca67d8948 100644 --- a/packages/techdocs-common/api-report.md +++ b/packages/techdocs-common/api-report.md @@ -256,7 +256,7 @@ export class TechdocsGenerator implements GeneratorBase { config: Config; scmIntegrations: ScmIntegrationRegistry; }); - static readonly defaultDockerImage = 'spotify/techdocs:v0.3.2'; + static readonly defaultDockerImage = 'spotify/techdocs:v0.3.3'; // (undocumented) static fromConfig( config: Config, diff --git a/packages/techdocs-common/src/stages/generate/techdocs.ts b/packages/techdocs-common/src/stages/generate/techdocs.ts index 5814fecea3..d5d4584c34 100644 --- a/packages/techdocs-common/src/stages/generate/techdocs.ts +++ b/packages/techdocs-common/src/stages/generate/techdocs.ts @@ -42,7 +42,7 @@ export class TechdocsGenerator implements GeneratorBase { * The default docker image (and version) used to generate content. Public * and static so that techdocs-common consumers can use the same version. */ - public static readonly defaultDockerImage = 'spotify/techdocs:v0.3.2'; + public static readonly defaultDockerImage = 'spotify/techdocs:v0.3.3'; private readonly logger: Logger; private readonly containerRunner: ContainerRunner; private readonly options: GeneratorConfig; diff --git a/plugins/techdocs-backend/examples/documented-component/docs/extensions.md b/plugins/techdocs-backend/examples/documented-component/docs/extensions.md index 40565bd42f..e9337ce042 100644 --- a/plugins/techdocs-backend/examples/documented-component/docs/extensions.md +++ b/plugins/techdocs-backend/examples/documented-component/docs/extensions.md @@ -87,3 +87,20 @@ I've read a lot of documentation, but I love :heart: this document. Weather: :sunny: :umbrella: :cloud: :snowflake: Animals: :tiger: :horse: :turtle: :wolf: :frog: + +### MDX truly sane lists + +- attributes + +- customer + - first_name + - test + - family_name + - email +- person + - first_name + - family_name + - birth_date +- subscription_id + +- request