From cd2a47bf2ee8a18d7a2350ae68af2186b7424096 Mon Sep 17 00:00:00 2001 From: Alin Stefan Olaru Date: Fri, 4 Jun 2021 18:54:14 +0200 Subject: [PATCH] docs: added example dockerfiles for techdocs and templating Signed-off-by: Alin Stefan Olaru --- docs/features/software-templates/installation.md | 7 +++++++ docs/features/techdocs/getting-started.md | 15 ++++++++++++--- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index ad7e6d1062..0ce34f9f87 100644 --- a/docs/features/software-templates/installation.md +++ b/docs/features/software-templates/installation.md @@ -270,3 +270,10 @@ docker image. If you are running Backstage from a Docker container and you want to avoid calling a container inside a container, you can set up Cookiecutter in your own image, this will use the local installation instead. + +You can do so by including the following lines in the last step of your `Dockerfile`: + +```Dockerfile +RUN apt-get update && apt-get install -y python3 python3-pip +RUN pip3 install cookiecutter +``` diff --git a/docs/features/techdocs/getting-started.md b/docs/features/techdocs/getting-started.md index 51f07d5cde..7eaadf92de 100644 --- a/docs/features/techdocs/getting-started.md +++ b/docs/features/techdocs/getting-started.md @@ -213,10 +213,19 @@ environment is compatible with techdocs. You will have to install the `mkdocs` and `mkdocs-techdocs-core` package from pip, as well as `graphviz` and `plantuml` from your OS package manager (e.g. -apt). See our +apt). + + +You can do so by including the following lines in the last step of your `Dockerfile`: + +```Dockerfile +RUN apt-get update && apt-get install -y python3 python3-pip +RUN pip3 install mkdocs-techdocs-core==0.0.16 +``` + +Please be aware that the version requirement could change, you need to check our [`Dockerfile`](https://github.com/backstage/techdocs-container/blob/main/Dockerfile) -for the latest requirements. You should be trying to match your `Dockerfile` -with this one. +and make sure to match with it. Note: We recommend Python version 3.7 or higher.