Skip to content
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.

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

feat(docs): Improve documentation about Search #5889

Merged
merged 17 commits into from
Oct 3, 2022

Conversation

szalai1
Copy link
Contributor

@szalai1 szalai1 commented Sep 9, 2022

(cherry picked from commit ec016b4)

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@jjoyce0510 jjoyce0510 self-requested a review September 9, 2022 17:38
Copy link
Collaborator

@jjoyce0510 jjoyce0510 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made various changes directly as commits on this PR. Overall looking good!

Once @gabe-lyons 's advanced search features land, we'll need to come back and revisit this

@anshbansal anshbansal added the docs Issues and Improvements to docs label Sep 12, 2022
@maggiehays
Copy link
Collaborator

maggiehays commented Sep 12, 2022

@szalai1 @jjoyce0510 we get a lot of questions from OSS about how Search results are ordered - can we add in those details in FAQ?

Copy link
Collaborator

@maggiehays maggiehays left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking great!! Left a few comments/requested changes for you to consider

docs/how/search.md Outdated Show resolved Hide resolved
docs/how/search.md Outdated Show resolved Hide resolved
docs/how/search.md Show resolved Hide resolved
docs/how/search.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@maggiehays maggiehays left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look great!

@hsheth2
Copy link
Collaborator

hsheth2 commented Sep 27, 2022

The formatting of the use case list is pretty ugly - not super readable, extra * characters, some headers are italics and others not

image

@szalai1 szalai1 merged commit 5fb875a into datahub-project:master Oct 3, 2022
@szalai1 szalai1 deleted the szalai1-improve-search-docs branch October 3, 2022 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and Improvements to docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants