chore(docs): cleanup location of guide, gitignore generated from git (#…

…4256)
datahub-project · Feb 25, 2022 · 4b4c7d5 · 4b4c7d5
1 parent 60e4656
commit 4b4c7d5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -57,3 +57,6 @@ smoke-test/spark-smoke-test/__pycache__/
 
 # Metadata Ingestion Generated
 metadata-ingestion/generated/**
+
+# docs
+docs/generated/
diff --git a/docs-website/sidebars.js b/docs-website/sidebars.js
@@ -59,12 +59,7 @@ module.exports = {
       "docs/saas",
       "releases",
     ],
-    "Getting Started": [
-      "docs/quickstart",
-      "docs/cli",
-      "docs/debugging",
-      "docs/how/search",
-    ],
+    "Getting Started": ["docs/quickstart", "docs/cli", "docs/debugging"],
     "Metadata Ingestion": [
       // add a custom label since the default is 'Metadata Ingestion'
       // note that we also have to add the path to this file in sidebarsjs_hardcoded_titles in generateDocsDir.ts
@@ -200,7 +195,12 @@ module.exports = {
         ],
       },
     ],
-    "Usage Guides": ["docs/policies", "docs/domains", "docs/ui-ingestion"],
+    "Usage Guides": [
+      "docs/policies",
+      "docs/domains",
+      "docs/ui-ingestion",
+      "docs/how/search",
+    ],
     "Developer Guides": [
       // TODO: the titles of these should not be in question form in the sidebar
       "docs/developers",

diff --git a/docs/how/search.md b/docs/how/search.md
@@ -1,10 +1,10 @@
-# How to Search for Information in Datahub
+# Search Guide
 
 ## Introduction 
 
 The search bar is one of the means of finding data in Datahub. In this document, we discuss more effective ways of finding information beyond doing a standard keyword search. This is because keyword searches can return results from almost any part of an entity.
 
-### Search in Specific Fields:  
+### Search in Specific Fields
 
 The following examples are in the format of  
 X: *typical question* :