Merge pull request #2592 from spotify/orkohunter/troubleshooting-techdocs

TechDocs: Add troubleshooting docs
2020-09-24 23:45:43 +02:00
parent eb6b2e6572 94aa8068af
commit bd7ae153f7
3 changed files with 12 additions and 0 deletions
@@ -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.
@@ -70,6 +70,7 @@
          "features/techdocs/concepts",
          "features/techdocs/architecture",
          "features/techdocs/creating-and-publishing",
+          "features/techdocs/troubleshooting",
          "features/techdocs/faqs"
        ]
      }
@@ -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'