Skip to content

docs(menu): consistency, wording fixes#1363

Merged
samsja merged 2 commits into
feat-rewrite-v2from
docs-menu-fix
Apr 13, 2023
Merged

docs(menu): consistency, wording fixes#1363
samsja merged 2 commits into
feat-rewrite-v2from
docs-menu-fix

Conversation

@alexcg1

@alexcg1 alexcg1 commented Apr 12, 2023

Copy link
Copy Markdown
Contributor

Goals:

  • Make wording consistent
  • FIx English

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

alexcg1 commented Apr 12, 2023

Copy link
Copy Markdown
Contributor Author

Where can I find the "Api references" string? grep shows no results
image

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

Copy link
Copy Markdown

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

@samsja

samsja commented Apr 12, 2023

Copy link
Copy Markdown
Member

Where can I find the "Api references" string? grep shows no results image

this is coming from the docstring of each python method

@alexcg1

alexcg1 commented Apr 13, 2023

Copy link
Copy Markdown
Contributor Author

@samsja can we merge this? I'll try working on the "Api references" issue separately

@samsja samsja merged commit f5b0ea3 into feat-rewrite-v2 Apr 13, 2023
@samsja samsja deleted the docs-menu-fix branch April 13, 2023 11:33
anna-charlotte pushed a commit that referenced this pull request Apr 13, 2023
* 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>
anna-charlotte pushed a commit that referenced this pull request Apr 14, 2023
* 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>
anna-charlotte pushed a commit that referenced this pull request Apr 14, 2023
* docs: add storing with file

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

* docs: add docs for the S3 store

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

* docs: add docs for jac store

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

* docs: store section in user guide

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

* docs: add doc stores to api reference section

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

* docs: fix docstrings

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

* fix: clean up

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

* fix: path in file doc store

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

* docs(menu): consistency, wording fixes (#1363)

* 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>

* fix: default dims=-1 for elastic index (#1368)

Signed-off-by: AnneY <evangeline-lun@foxmail.com>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>

* fix: s3 bucket var

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

* fix: typo and s3 delete code snippet

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

* docs: exclude jacdocstore docs from test for now

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

* Revert "docs: exclude jacdocstore docs from test for now"

This reverts commit a52fed5.

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

* docs: exclude jac tests

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

* feat: weaviate document index V2! (#1367)

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

* docs: add sending section (#1350)

* 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>

* fix: apply sami suggestion

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>

* fix: apply suggestions from samis code review

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

* docs: add missing links and clean up (#1370)

* 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>

---------

Signed-off-by: nan-wang <nan.wang@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: Alex C-G <alexcg@outlook.com>
Signed-off-by: AnneY <evangeline-lun@foxmail.com>
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
Signed-off-by: samsja <55492238+samsja@users.noreply.github.com>
Signed-off-by: Charlotte Gerhaher <charlotte.gerhaher@jina.ai>
Co-authored-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Anne Yang <evangeline-lun@foxmail.com>
Co-authored-by: Shukri <hsm207@users.noreply.github.com>
Co-authored-by: samsja <sami.jaghouar@hotmail.fr>
Co-authored-by: samsja <55492238+samsja@users.noreply.github.com>
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.

2 participants