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

docs: updating docstrings to say OpenSearch and backlink to correct docs #5000

Merged
merged 2 commits into from
May 25, 2023

Conversation

dtaivpp
Copy link
Contributor

@dtaivpp dtaivpp commented May 23, 2023

  • Updated several references to Elasticsearch to say OpenSearch
  • Added backlinks to OpenSearch's documentation where documentation was present

Related Issues

N/A

Proposed Changes:

There were several references to Elasticsearch in the OpenSearch Document store docstrings. I updated them to say OpenSearch and changed several links to reference OpenSearch's documentation except where documentation may still need to be added.

How did you test it?

No tests as it's just docs.

Notes for the reviewer

Feel free to reach out if there are issues with anything Ive added.

Checklist

  • I have read the contributors guidelines and the code of conduct
  • I have updated the related issue with new insights and changes
    ~~ - [ ] I added tests that demonstrate the correct behavior of the change ~~
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test:.
  • I documented my code
  • I ran pre-commit hooks and fixed any issue

@dtaivpp dtaivpp requested a review from a team as a code owner May 23, 2023 19:01
@dtaivpp dtaivpp requested review from vblagoje and removed request for a team May 23, 2023 19:01
@CLAassistant
Copy link

CLAassistant commented May 23, 2023

CLA assistant check
All committers have signed the CLA.

- Added backlinks to OpenSearch's documentation where documentation was present

Signed-off-by: David Tippett <[email protected]>
Copy link
Contributor

@ZanSara ZanSara left a comment

Choose a reason for hiding this comment

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

Thank you for the help!

@dtaivpp
Copy link
Contributor Author

dtaivpp commented May 24, 2023

Happy to help where I can 😀

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 5073122460

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 39.63%

Totals Coverage Status
Change from base Build 5071396879: 0.0%
Covered Lines: 8874
Relevant Lines: 22392

💛 - Coveralls

@julian-risch julian-risch merged commit 934db42 into deepset-ai:main May 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants