From 94aa8068af390e595a01f16c4d22cbcc3345b97f Mon Sep 17 00:00:00 2001
From: Himanshu Mishra <himanshu@orkohunter.net>
Date: Thu, 24 Sep 2020 16:20:16 +0200
Subject: [PATCH] TechDocs: Add troubleshooting docs

---
 docs/features/techdocs/troubleshooting.md | 10 ++++++++++
 microsite/sidebars.json                   |  1 +
 mkdocs.yml                                |  1 +
 3 files changed, 12 insertions(+)
 create mode 100644 docs/features/techdocs/troubleshooting.md

diff --git a/docs/features/techdocs/troubleshooting.md b/docs/features/techdocs/troubleshooting.md
new file mode 100644
index 0000000000..3a9b2fcfd0
--- /dev/null
+++ b/docs/features/techdocs/troubleshooting.md
@@ -0,0 +1,10 @@
+---
+id: troubleshooting
+title: Troubleshooting TechDocs
+sidebar_label: Troubleshooting
+description: Troubleshooting for TechDocs
+---
+
+- TechDocs will fail to clone your docs if you have a git config which overrides
+  the `https` protocol with `ssh` or something else. Make sure to remove your
+  git config locally when you try TechDocs.
diff --git a/microsite/sidebars.json b/microsite/sidebars.json
index e9993b2e8b..76709e5726 100644
--- a/microsite/sidebars.json
+++ b/microsite/sidebars.json
@@ -70,6 +70,7 @@
           "features/techdocs/concepts",
           "features/techdocs/architecture",
           "features/techdocs/creating-and-publishing",
+          "features/techdocs/troubleshooting",
           "features/techdocs/faqs"
         ]
       }
diff --git a/mkdocs.yml b/mkdocs.yml
index f85044822e..58dc418925 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -50,6 +50,7 @@ nav:
           - Concepts: 'features/techdocs/concepts.md'
           - TechDocs Architecture: 'features/techdocs/architecture.md'
           - Creating and Publishing Documentation: 'features/techdocs/creating-and-publishing.md'
+          - Troubleshooting: 'features/techdocs/troubleshooting.md'
           - FAQ: 'features/techdocs/FAQ.md'
   - Plugins:
       - Overview: 'plugins/index.md'