Skip to content

docs: add storing with file#1348

Merged
anna-charlotte merged 21 commits into
feat-rewrite-v2from
docs-store-0409
Apr 14, 2023
Merged

docs: add storing with file#1348
anna-charlotte merged 21 commits into
feat-rewrite-v2from
docs-store-0409

Conversation

@nan-wang

@nan-wang nan-wang commented Apr 9, 2023

Copy link
Copy Markdown
Collaborator

Goals:

  • add documentation for the storing part
  • check and update documentation, if required. See guide

@nan-wang nan-wang marked this pull request as draft April 9, 2023 09:48
@anna-charlotte

Copy link
Copy Markdown
Contributor

hey @nan-wang do you mind if I take over this PR?

Comment thread docs/api_references/doc_store/doc_store.md Outdated

@samsja samsja left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks really good ! .

on comment, can we put the three docs about push pull into a common folder ? So that we have distinction between DocStore and DocIndex Screenshot from 2023-04-14 09-05-00

nan-wang and others added 12 commits April 14, 2023 09:41
Signed-off-by: nan-wang <nan.wang@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: nan-wang <nan.wang@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: nan-wang <nan.wang@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
* docs(menu): consistency, wording fixes

Signed-off-by: Alex C-G <alexcg@outlook.com>

* docs(intro): remove redundancy in title

Signed-off-by: Alex C-G <alexcg@outlook.com>

---------

Signed-off-by: Alex C-G <alexcg@outlook.com>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: AnneY <evangeline-lun@foxmail.com>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
anna-charlotte and others added 8 commits April 14, 2023 09:41
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
This reverts commit a52fed5.

Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
* docs: add serialization for json

Signed-off-by: nan-wang <nan.wang@jina.ai>

* docs: add serialization for binary and protobuf

Signed-off-by: nan-wang <nan.wang@jina.ai>

* docs: add serialization for base64 and bytes

Signed-off-by: nan-wang <nan.wang@jina.ai>

* docs: add serialization for csv

Signed-off-by: nan-wang <nan.wang@jina.ai>

* docs: add serialization for dataframe

Signed-off-by: nan-wang <nan.wang@jina.ai>

* fix: add doctring to documentaion basedoc

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix mypy

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: add docstring doc list

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: dic doc array docstring

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix page for doc list serilizaiton

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix docstring

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* feat: add docvec

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* docs: add send doc section

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* docs: fix docstring

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* refactor: better tree structure for sending

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix tests

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix python code snippet ods

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix remove breakpoint

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* feat: add intro

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* feat: add ref

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* feat: move fastapi part

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix fastAPI

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: remove uselss mixin

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* faet: add jina section

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: compress -> compression

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* feat: apply suggestion

Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Charlotte Gerhaher <charlotte.gerhaher@jina.ai>
Signed-off-by: samsja <55492238+samsja@users.noreply.github.com>

* fix: apply alex suggestion

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* wip

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix all docstring

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix update docstring

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix ruff

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* fix: fix smth

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>

* feat: apply charllote suggestion

Co-authored-by: Charlotte Gerhaher <charlotte.gerhaher@jina.ai>
Signed-off-by: samsja <55492238+samsja@users.noreply.github.com>

---------

Signed-off-by: nan-wang <nan.wang@jina.ai>
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
Signed-off-by: samsja <55492238+samsja@users.noreply.github.com>
Co-authored-by: samsja <sami.jaghouar@hotmail.fr>
Co-authored-by: samsja <55492238+samsja@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Charlotte Gerhaher <charlotte.gerhaher@jina.ai>
Co-authored-by: samsja <55492238+samsja@users.noreply.github.com>
Signed-off-by: Charlotte Gerhaher <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
* docs: add links and clean up

Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>

* fix: Text to TextDoc

Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>

* fix: 3d urls

Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>

* fix: pc url

Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>

* fix: comment out display pc

Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>

---------

Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
…-0409

Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
@github-actions

Copy link
Copy Markdown

📝 Docs are deployed on https://ft-docs-store-0409--jina-docs.netlify.app 🎉

@anna-charlotte anna-charlotte merged commit 13c97fe into feat-rewrite-v2 Apr 14, 2023
@anna-charlotte anna-charlotte deleted the docs-store-0409 branch April 14, 2023 07:59
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.

6 participants