From 11c47adcddfaee534de51d11cbb7df9f0ae9d125 Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Fri, 30 Jul 2021 12:54:51 +0200 Subject: [PATCH] docs/techdocs: Indicate optional configs explicitly Signed-off-by: Himanshu Mishra --- docs/features/techdocs/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/features/techdocs/configuration.md b/docs/features/techdocs/configuration.md index ef6a80d44c..4bb6857106 100644 --- a/docs/features/techdocs/configuration.md +++ b/docs/features/techdocs/configuration.md @@ -24,13 +24,13 @@ techdocs: runIn: 'docker' - # techdocs.generator.dockerImage can be used to control the docker image used during documentation generation. This can be useful + # (Optional) techdocs.generator.dockerImage can be used to control the docker image used during documentation generation. This can be useful # if you want to use MkDocs plugins or other packages that are not included in the default techdocs-container (spotify/techdocs). # NOTE: This setting is only used when techdocs.generator.runIn is set to 'docker'. dockerImage: 'spotify/techdocs' - # techdocs.generator.pullImage can be used to disable pulling the latest docker image by default. This can be useful when you are + # (Optional) techdocs.generator.pullImage can be used to disable pulling the latest docker image by default. This can be useful when you are # using a custom techdocs.generator.dockerImage and you have a custom docker login requirement. For example, you need to login to # AWS ECR to pull the docker image. # NOTE: Disabling this requires the docker image was pulled by other means before running the techdocs generator.