Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 25, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,6 @@ smoke-test/spark-smoke-test/__pycache__/

# Metadata Ingestion Generated
metadata-ingestion/generated/**

# docs
docs/generated/
14 changes: 7 additions & 7 deletions docs-website/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions docs/how/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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* :
Expand Down