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

basic docs for the elasticsearch connector #886

Merged
merged 5 commits into from
Feb 7, 2025

Conversation

m-Bilal
Copy link
Member

@m-Bilal m-Bilal commented Feb 7, 2025

Description 📝

The following docs have been added for the Elasticsearch Connector

  • Configuration
  • How to use Elasticsearch with DDN

Quick Links 🚀

Assertion Tests 🤖

@hasura-bot
Copy link
Contributor

@m-Bilal Thanks for your PR! I've assigned @robertjdominguez to review it.

@hasura-bot
Copy link
Contributor

hasura-bot commented Feb 7, 2025

DX: Assertion Testing

✅ Diff

The PR provides a comprehensive guide for integrating Hasura DDN with Elasticsearch, covering authentication, project setup, Elasticsearch container initialization, and querying. It's well-structured with descriptive subheadings and clear code snippets. However, please make sure that all CLI commands used are compatible with the current system configurations and are tested to work as intended.

✅ Integrated

The documentation integrates well with the existing structure, maintaining consistency in format and style. The addition respects the sidebar positioning and keywords, ensuring the new content fits smoothly into the navigation flow. Updating the 'with-others.mdx' file's sidebar position ensures there are no conflicts or overlaps, keeping the documentation organized. Just ensure proper linking to the relevant sections and documentation for continuity and ease of navigation.

Copy link

cloudflare-workers-and-pages bot commented Feb 7, 2025

Deploying ddn-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 536dbd0
Status: ✅  Deploy successful!
Preview URL: https://d56cff83.v3-docs-eny.pages.dev
Branch Preview URL: https://m-bilal-docs-elasticsearch-b.v3-docs-eny.pages.dev

View logs

@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
Copy link
Member Author

@m-Bilal m-Bilal Feb 7, 2025

Choose a reason for hiding this comment

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

DBs in this section were not sorted alphabetically. For now, I just made elastic position 6 and moved this to position 7. Let me know please @robertjdominguez if that's okay

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yep, we can alphabetize in a follow-up 👍

Bumping this as you have is perfect for now.

@m-Bilal
Copy link
Member Author

m-Bilal commented Feb 7, 2025

Relationship docs not added due to this issue.

@m-Bilal m-Bilal requested a review from gneeri February 7, 2025 20:27
Copy link
Collaborator

@robertjdominguez robertjdominguez left a comment

Choose a reason for hiding this comment

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

Thanks for this, @m-Bilal! A few requests listed below. Should I also wait for @gneeri to review before merging after you take care of the points listed in the review?

@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
Copy link
Collaborator

Choose a reason for hiding this comment

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

Yep, we can alphabetize in a follow-up 👍

Bumping this as you have is perfect for now.

docs/how-to-build-with-ddn/with-elasticsearch.mdx Outdated Show resolved Hide resolved
docs/reference/connectors/elasticsearch/index.mdx Outdated Show resolved Hide resolved
@m-Bilal
Copy link
Member Author

m-Bilal commented Feb 7, 2025

Should I also wait for @gneeri to review before merging

I'm not sure. You can inform him if things look good to you, and he can tell you whether or not he'd like to take a look as well.

Thanks for the quick review @robertjdominguez ! ❤️

Copy link
Collaborator

@robertjdominguez robertjdominguez left a comment

Choose a reason for hiding this comment

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

Thanks, @m-Bilal! Let's ship it. If @gneeri has edits, he knows where to find me at the HKO 😉

@robertjdominguez robertjdominguez merged commit 9055f41 into main Feb 7, 2025
4 checks passed
@robertjdominguez robertjdominguez deleted the m-bilal/docs/elasticsearch-basics branch February 7, 2025 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants