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 "Creating Custom Document Stores" documentation #6972

Closed
11 of 12 tasks
dfokina opened this issue Feb 12, 2024 · 3 comments
Closed
11 of 12 tasks

Improve "Creating Custom Document Stores" documentation #6972

dfokina opened this issue Feb 12, 2024 · 3 comments
Assignees
Labels
2.x Related to Haystack v2.0 P1 High priority, add to the next sprint type:documentation Improvements on the docs
Milestone

Comments

@dfokina
Copy link
Contributor

dfokina commented Feb 12, 2024

Tasks

@dfokina dfokina added type:documentation Improvements on the docs 2.x Related to Haystack v2.0 labels Feb 12, 2024
@TuanaCelik TuanaCelik added the P2 Medium priority, add to the next sprint if no P1 available label Feb 12, 2024
@masci masci added P1 High priority, add to the next sprint and removed P2 Medium priority, add to the next sprint if no P1 available labels Feb 23, 2024
@masci masci added this to the 2.0.0 milestone Feb 23, 2024
@TuanaCelik
Copy link
Member

@masci here are a list of things I see as missing in the current docs, and some others that would be useful in discussions with document store providers that we speak to:

  • How we expect to find the document store: e.g.: We expect them in a separate repo, with XYZ structure, and an accompanying package distributed on PyPI
  • Our recommendations on package naming
  • The naming convention of Haystack components, in particular retrievers
  • How we expect them to handle secret management
  • How we expect them to handle device management (if needed)
  • What they should do for serialization

Following that, instructions on how to get featured. I see this as a todo list:

  • Prepare a public repository
  • Release the package
  • Draft a documentation page following the draft.md in the haystack-integrations repo and create a PR.
  • Optionally but very useful, host an api docs for your document store

We could also give exemplary repos in the doc IMO. For example, the Neo4j one is amazing, and has its own docs etc.

@anakin87
Copy link
Member

Also adding some suggestions on how to develop the document store using DocumentStoreBaseTests might help.
deepset-ai/haystack-core-integrations#142 (comment)

@masci masci assigned masci and unassigned TuanaCelik Feb 26, 2024
@masci
Copy link
Contributor

masci commented Feb 27, 2024

Template repository is up to date now.

@masci masci closed this as completed Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Related to Haystack v2.0 P1 High priority, add to the next sprint type:documentation Improvements on the docs
Projects
None yet
Development

No branches or pull requests

4 participants