From 9fa68705bf8f8174c69cd492eaaa219f83d5c31e Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Tue, 19 Apr 2022 13:21:08 +0200 Subject: [PATCH] Update default TechDocs container to v1.0.2 Signed-off-by: Eric Peterson --- .changeset/techdocs-lumon-industries.md | 5 +++++ docs/features/techdocs/cli.md | 2 +- docs/features/techdocs/configuring-ci-cd.md | 4 ++-- docs/features/techdocs/getting-started.md | 2 +- docs/features/techdocs/how-to-guides.md | 2 +- plugins/techdocs-node/api-report.md | 2 +- plugins/techdocs-node/src/stages/generate/techdocs.ts | 2 +- 7 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 .changeset/techdocs-lumon-industries.md diff --git a/.changeset/techdocs-lumon-industries.md b/.changeset/techdocs-lumon-industries.md new file mode 100644 index 0000000000..fff150105e --- /dev/null +++ b/.changeset/techdocs-lumon-industries.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-techdocs-node': patch +--- + +The default container version used to generate TechDocs content is now `v1.0.2`. diff --git a/docs/features/techdocs/cli.md b/docs/features/techdocs/cli.md index 6f6dbf7552..9a7dccd5a6 100644 --- a/docs/features/techdocs/cli.md +++ b/docs/features/techdocs/cli.md @@ -120,7 +120,7 @@ Generate TechDocs documentation site using MkDocs. Options: --source-dir Source directory containing mkdocs.yml and docs/ directory. (default: ".") --output-dir Output directory containing generated TechDocs site. (default: "./site/") - --docker-image The mkdocs docker container to use (default: "spotify/techdocs:v0.3.6") + --docker-image The mkdocs docker container to use (default: "spotify/techdocs:v1.0.2") --no-pull Do not pull the latest docker image --no-docker Do not use Docker, use MkDocs executable and plugins in current user environment. --techdocs-ref The repository hosting documentation source files e.g. diff --git a/docs/features/techdocs/configuring-ci-cd.md b/docs/features/techdocs/configuring-ci-cd.md index a4da4e5d95..0f8044e9c9 100644 --- a/docs/features/techdocs/configuring-ci-cd.md +++ b/docs/features/techdocs/configuring-ci-cd.md @@ -29,7 +29,7 @@ cd repo # Install @techdocs/cli, mkdocs and mkdocs plugins npm install -g @techdocs/cli -pip install mkdocs-techdocs-core==0.* +pip install mkdocs-techdocs-core==1.* # Generate techdocs-cli generate --no-docker @@ -167,7 +167,7 @@ jobs: run: sudo npm install -g @techdocs/cli - name: Install mkdocs and mkdocs plugins - run: python -m pip install mkdocs-techdocs-core==0.* + run: python -m pip install mkdocs-techdocs-core==1.* - name: Generate docs site run: techdocs-cli generate --no-docker --verbose diff --git a/docs/features/techdocs/getting-started.md b/docs/features/techdocs/getting-started.md index 30d846efda..1eeebae903 100644 --- a/docs/features/techdocs/getting-started.md +++ b/docs/features/techdocs/getting-started.md @@ -227,7 +227,7 @@ You can do so by including the following lines in the last step of your ```Dockerfile RUN apt-get update && apt-get install -y python3 python3-pip -RUN pip3 install mkdocs-techdocs-core==0.2.2 +RUN pip3 install mkdocs-techdocs-core==1.0.1 ``` Please be aware that the version requirement could change, you need to check our diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index 0c3bc98c09..4f2dc6c348 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -437,7 +437,7 @@ FROM python:3.8-alpine RUN apk update && apk --no-cache add gcc musl-dev openjdk11-jdk curl graphviz ttf-dejavu fontconfig -RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==0.2.1 +RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==1.0.1 RUN pip install mkdocs-kroki-plugin diff --git a/plugins/techdocs-node/api-report.md b/plugins/techdocs-node/api-report.md index 350e67e1c3..d099f7351a 100644 --- a/plugins/techdocs-node/api-report.md +++ b/plugins/techdocs-node/api-report.md @@ -219,7 +219,7 @@ export class TechdocsGenerator implements GeneratorBase { config: Config; scmIntegrations: ScmIntegrationRegistry; }); - static readonly defaultDockerImage = 'spotify/techdocs:v0.3.7'; + static readonly defaultDockerImage = 'spotify/techdocs:v1.0.2'; static fromConfig( config: Config, options: GeneratorOptions, diff --git a/plugins/techdocs-node/src/stages/generate/techdocs.ts b/plugins/techdocs-node/src/stages/generate/techdocs.ts index c9e26e9d7a..41b17d3bc6 100644 --- a/plugins/techdocs-node/src/stages/generate/techdocs.ts +++ b/plugins/techdocs-node/src/stages/generate/techdocs.ts @@ -53,7 +53,7 @@ export class TechdocsGenerator implements GeneratorBase { * The default docker image (and version) used to generate content. Public * and static so that techdocs-node consumers can use the same version. */ - public static readonly defaultDockerImage = 'spotify/techdocs:v0.3.7'; + public static readonly defaultDockerImage = 'spotify/techdocs:v1.0.2'; private readonly logger: Logger; private readonly containerRunner: ContainerRunner; private readonly options: GeneratorConfig;