From 6df49ad80cd8d27333201208cb90f04bb06cb5d2 Mon Sep 17 00:00:00 2001 From: Nils Schmidt Date: Mon, 23 Sep 2019 17:24:14 +0200 Subject: [PATCH] Make updating custom-domain configmap clearer (#1811) The current documentation is confusing because it does not show the contents of the default configmap : https://github.com/knative/serving/blob/master/config/config-domain.yaml The default configmap has an additional `_example` key in front of the domain. --- docs/serving/using-a-custom-domain.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/serving/using-a-custom-domain.md b/docs/serving/using-a-custom-domain.md index 2bd1317b8..d2aa87bbd 100644 --- a/docs/serving/using-a-custom-domain.md +++ b/docs/serving/using-a-custom-domain.md @@ -20,20 +20,26 @@ To change the {default-domain} value there are a few steps involved: kubectl edit cm config-domain --namespace knative-serving ``` - This command opens your default text editor and allows you to edit the config - map. + This command opens your default text editor and allows you to edit the [config + map](https://github.com/knative/serving/blob/master/config/config-domain.yaml). ```yaml apiVersion: v1 data: - example.com: "" + _example: | + ################################ + # # + # EXAMPLE CONFIGURATION # + # # + ################################ + # ... + example.com: | kind: ConfigMap - [...] ``` -1. Edit the file to replace `example.com` with the domain you'd like to use and - save your changes. In this example, we configure `mydomain.com` for all - routes: +1. Edit the file to replace `example.com` with the domain you'd like to use, + remove the `_example` key and save your changes. + In this example, we configure `mydomain.com` for all routes: ```yaml apiVersion: v1