From 29e269d9207a8e641afe06b5cfaa7c03bc661e2d Mon Sep 17 00:00:00 2001
From: Himanshu Mishra <himanshu@orkohunter.net>
Date: Thu, 28 Jan 2021 18:51:18 +0100
Subject: [PATCH] TechDocs: Remove traces of requestUrl/storageUrl from docs

---
 docs/features/techdocs/configuration.md   | 20 +++++++++++---------
 docs/features/techdocs/getting-started.md | 21 +++------------------
 2 files changed, 14 insertions(+), 27 deletions(-)

diff --git a/docs/features/techdocs/configuration.md b/docs/features/techdocs/configuration.md
index b9413227af..20e436d8a4 100644
--- a/docs/features/techdocs/configuration.md
+++ b/docs/features/techdocs/configuration.md
@@ -13,15 +13,6 @@ configuration options for TechDocs.
 # File: app-config.yaml
 
 techdocs:
-  # TechDocs makes API calls to techdocs-backend using this URL. e.g. get docs of an entity, get metadata, etc. (Optional)
-
-  requestUrl: http://localhost:7000/api/techdocs
-
-  # Just another route in techdocs-backend where TechDocs requests the static files from. This URL uses an HTTP middleware
-  # to serve files from either a local directory or an External storage provider. (Optional)
-
-  storageUrl: http://localhost:7000/api/techdocs/static/docs
-
   # generators.techdocs can have two values: 'docker' or 'local'. This is to determine how to run the generator - whether to
   # spin up the techdocs-container docker image or to run mkdocs locally (assuming all the dependencies are taken care of).
   # You want to change this to 'local' if you are running Backstage using your own custom Docker setup and want to avoid running
@@ -101,4 +92,15 @@ techdocs:
         # https://docs.microsoft.com/en-us/azure/storage/common/storage-auth?toc=/azure/storage/blobs/toc.json
         accountKey:
           $env: TECHDOCS_AZURE_BLOB_STORAGE_ACCOUNT_KEY
+
+  # (Optional and Legacy) TechDocs makes API calls to techdocs-backend using this URL. e.g. get docs of an entity, get metadata, etc.
+  # You don't have to specify this anymore.
+
+  requestUrl: http://localhost:7000/api/techdocs
+
+  # (Optional and Legacy) Just another route in techdocs-backend where TechDocs requests the static files from. This URL uses an HTTP middleware
+  # to serve files from either a local directory or an External storage provider.
+  # You don't have to specify this anymore.
+
+  storageUrl: http://localhost:7000/api/techdocs/static/docs
 ```
diff --git a/docs/features/techdocs/getting-started.md b/docs/features/techdocs/getting-started.md
index 5147e17aaa..e0b323857d 100644
--- a/docs/features/techdocs/getting-started.md
+++ b/docs/features/techdocs/getting-started.md
@@ -150,26 +150,10 @@ app. Now let us tweak some configurations to suit your needs.
 **See [TechDocs Configuration Options](configuration.md) for complete
 configuration reference.**
 
-### Setting TechDocs URLs
-
-```yaml
-techdocs:
-  storageUrl: http://localhost:7000/api/techdocs/static/docs
-  requestUrl: http://localhost:7000/api/techdocs/
-```
-
-`requestUrl` is used by TechDocs frontend plugin to discover `techdocs-backend`
-endpoints, and the `storageUrl` is another endpoint in `techdocs-backend` which
-acts as a middleware between TechDocs and the storage (where the static
-generated docs site are stored). These default values should mostly work for
-you. These options will soon be optional to set.
-
 ### Should TechDocs Backend generate docs?
 
 ```yaml
 techdocs:
-  storageUrl: http://localhost:7000/api/techdocs/static/docs
-  requestUrl: http://localhost:7000/api/techdocs/
   builder: 'local'
 ```
 
@@ -196,8 +180,6 @@ out Backstage for the first time. At a later time, review
 
 ```yaml
 techdocs:
-  storageUrl: http://localhost:7000/api/techdocs/static/docs
-  requestUrl: http://localhost:7000/api/techdocs/
   builder: 'local'
   publisher:
     type: 'local'
@@ -219,6 +201,9 @@ no config is provided.
 
 ```yaml
 techdocs:
+  builder: 'local'
+  publisher:
+    type: 'local'
   generators:
     techdocs: local
 ```