Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Add search notebooks readme #28

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

Merged
leemthompo merged 4 commits into elastic:main from leemthompo:notebook-readmes
Aug 7, 2023
Merged

Conversation

@leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Aug 7, 2023

No description provided.

@leemthompo leemthompo added the documentation Improvements or additions to documentation label Aug 7, 2023
Comment on lines 7 to 10
0. [Quick start 🔗](./00-quick-start.ipynb)
1. [Keyword, querying, filtering 🔗](./01-keyword-querying-filtering.ipynb)
2. [Hybrid search 🔗](./02-hybrid-search.ipynb)
3. [Semantic search with ELSER 🔗](./03-ELSER.ipynb)
Copy link
Contributor

@demjened demjened Aug 7, 2023

Choose a reason for hiding this comment

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

Aren't these supposed to be anchor links to jump to the corresponding section in the page?
Also, what are the 🔗 icons for?

Suggested change
0. [Quick start 🔗](./00-quick-start.ipynb)
1. [Keyword, querying, filtering 🔗](./01-keyword-querying-filtering.ipynb)
2. [Hybrid search 🔗](./02-hybrid-search.ipynb)
3. [Semantic search with ELSER 🔗](./03-ELSER.ipynb)
0. [Quick start 🔗](#0-quick-start-🔗)
1. [Keyword, querying, filtering 🔗](#1-keyword-querying-filtering-🔗)
2. [Hybrid search 🔗](#2-hybrid-search-🔗)
3. [Semantic search with ELSER 🔗](#3-semantic-search-with-elser-🔗)

Copy link
Contributor Author

@leemthompo leemthompo Aug 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Aren't these supposed to be anchor links to jump to the corresponding section in the page?
Also, what are the 🔗 icons for?

  • Fixed anchor links, thanks!
  • The icons were meant to make it super clear that the headings were links. I've changed the format, to remove this signposting. LMKWYT!

demjened reacted with heart emoji
Copy link
Contributor

@demjened demjened Aug 7, 2023

Choose a reason for hiding this comment

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

I like it! The monospace formatting within the links makes them stand out, we should continue to use that to point to notebooks or examples.

Copy link
Contributor Author

@demjened @joemcelroy I went with bullet point summaries for this first category readme but I'm not sure if this is the best approach. LMKWYT!

@demjened demjened self-requested a review August 7, 2023 14:13
Copy link
Contributor

@demjened demjened left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@leemthompo leemthompo merged commit 1b2f60c into elastic:main Aug 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@demjened demjened demjened approved these changes

@joemcelroy joemcelroy Awaiting requested review from joemcelroy

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /