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

Improve Documentation #8

Open
sboeckelmann opened this issue Jan 2, 2023 · 7 comments
Open

Improve Documentation #8

sboeckelmann opened this issue Jan 2, 2023 · 7 comments

Comments

@sboeckelmann
Copy link
Contributor

the existing bare minimal documentation should be improved:

  • Add some background information for OpenSearch
  • document both: simple rest client and rest hight-level client
  • add some example
  • add documentation for dev mode
@sboeckelmann
Copy link
Contributor Author

  • Add some background information for OpenSearch
  • document both: simple rest client and rest hight-level client

#13

@melloware
Copy link

This would be great as I also don't see from looking at your code how do you configure where the OpenSearch cluster you are connecting to is? Something like..

quarkus.opensearch.base.url=...

???

@melloware
Copy link

Thanks! I was looking here and didn't find it: https://quarkiverse.github.io/quarkiverse-docs/index/index/index.html

@sboeckelmann
Copy link
Contributor Author

Thank you for reporting!
I will check and get it fixed.

@sboeckelmann
Copy link
Contributor Author

@melloware
documentation was added to quarkiverse documentation.
You can now see it where it belongs
https://quarkiverse.github.io/quarkiverse-docs/quarkus-opensearch/dev/index.html

I will keep updating and improving the documentation.

@melloware
Copy link

Excellent thank you!

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

When branches are created from issues, their pull requests are automatically linked.

2 participants