Skip to content

docs: add storing with file#1348

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

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

Conversation

@nan-wang
Copy link
Copy Markdown
Collaborator

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

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?

Copy link
Copy Markdown
Member

@samsja samsja left a comment

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 <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: nan-wang <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: nan-wang <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
* docs(menu): consistency, wording fixes

Signed-off-by: Alex C-G <[email protected]>

* docs(intro): remove redundancy in title

Signed-off-by: Alex C-G <[email protected]>

---------

Signed-off-by: Alex C-G <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: AnneY <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
anna-charlotte and others added 8 commits April 14, 2023 09:41
This reverts commit a52fed5.

Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
* docs: add serialization for json

Signed-off-by: nan-wang <[email protected]>

* docs: add serialization for binary and protobuf

Signed-off-by: nan-wang <[email protected]>

* docs: add serialization for base64 and bytes

Signed-off-by: nan-wang <[email protected]>

* docs: add serialization for csv

Signed-off-by: nan-wang <[email protected]>

* docs: add serialization for dataframe

Signed-off-by: nan-wang <[email protected]>

* fix: add doctring to documentaion basedoc

Signed-off-by: samsja <[email protected]>

* fix: fix mypy

Signed-off-by: samsja <[email protected]>

* fix: add docstring doc list

Signed-off-by: samsja <[email protected]>

* fix: dic doc array docstring

Signed-off-by: samsja <[email protected]>

* fix: fix page for doc list serilizaiton

Signed-off-by: samsja <[email protected]>

* fix: fix docstring

Signed-off-by: samsja <[email protected]>

* feat: add docvec

Signed-off-by: samsja <[email protected]>

* docs: add send doc section

Signed-off-by: samsja <[email protected]>

* docs: fix docstring

Signed-off-by: samsja <[email protected]>

* refactor: better tree structure for sending

Signed-off-by: samsja <[email protected]>

* fix: fix tests

Signed-off-by: samsja <[email protected]>

* fix: fix python code snippet ods

Signed-off-by: samsja <[email protected]>

* fix: fix remove breakpoint

Signed-off-by: samsja <[email protected]>

* feat: add intro

Signed-off-by: samsja <[email protected]>

* feat: add ref

Signed-off-by: samsja <[email protected]>

* feat: move fastapi part

Signed-off-by: samsja <[email protected]>

* fix: fix fastAPI

Signed-off-by: samsja <[email protected]>

* fix: remove uselss mixin

Signed-off-by: samsja <[email protected]>

* faet: add jina section

Signed-off-by: samsja <[email protected]>

* fix: compress -> compression

Signed-off-by: samsja <[email protected]>

* feat: apply suggestion

Co-authored-by: Alex Cureton-Griffiths <[email protected]>
Co-authored-by: Charlotte Gerhaher <[email protected]>
Signed-off-by: samsja <[email protected]>

* fix: apply alex suggestion

Signed-off-by: samsja <[email protected]>

* wip

Signed-off-by: samsja <[email protected]>

* fix: fix all docstring

Signed-off-by: samsja <[email protected]>

* fix: fix update docstring

Signed-off-by: samsja <[email protected]>

* fix: fix ruff

Signed-off-by: samsja <[email protected]>

* fix: fix smth

Signed-off-by: samsja <[email protected]>

* feat: apply charllote suggestion

Co-authored-by: Charlotte Gerhaher <[email protected]>
Signed-off-by: samsja <[email protected]>

---------

Signed-off-by: nan-wang <[email protected]>
Signed-off-by: samsja <[email protected]>
Signed-off-by: samsja <[email protected]>
Co-authored-by: samsja <[email protected]>
Co-authored-by: samsja <[email protected]>
Co-authored-by: Alex Cureton-Griffiths <[email protected]>
Co-authored-by: Charlotte Gerhaher <[email protected]>
Co-authored-by: samsja <[email protected]>
Signed-off-by: Charlotte Gerhaher <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
* docs: add links and clean up

Signed-off-by: anna-charlotte <[email protected]>

* fix: Text to TextDoc

Signed-off-by: anna-charlotte <[email protected]>

* fix: 3d urls

Signed-off-by: anna-charlotte <[email protected]>

* fix: pc url

Signed-off-by: anna-charlotte <[email protected]>

* fix: comment out display pc

Signed-off-by: anna-charlotte <[email protected]>

---------

Signed-off-by: anna-charlotte <[email protected]>
@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