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: adapt to 3.0 #4254

Merged
merged 193 commits into from
Feb 15, 2022
Merged

docs: adapt to 3.0 #4254

merged 193 commits into from
Feb 15, 2022

Conversation

JoanFM
Copy link
Member

@JoanFM JoanFM commented Feb 8, 2022

Pull Request Title

Description

Please describe what your PR is doing and why. Are there any parts which need extra attention during review? Are there any dependencies from other PRs or projcts? Is this a breaking change?

Is this PR ready or work in progress (WIP)? Ready means it can be reviewed and merged from the author's perspective. If the PR is WIP: Make it a draft PR and state open questions and TODO items.

Closes # (issue)

@github-actions github-actions bot added size/XL area/docs This issue/PR affects the docs labels Feb 8, 2022
@JoanFM JoanFM changed the title Docs3 0 docs: adapt to 3.0 Feb 8, 2022
@JoanFM JoanFM requested a review from alexcg1 February 8, 2022 10:53
@github-actions
Copy link

github-actions bot commented Feb 8, 2022

Latency summary

Current PR yields:

  • 🐢🐢 index QPS at 861, delta to last 2 avg.: -39%
  • 🐢🐢 query QPS at 36, delta to last 2 avg.: -11%
  • 🐎🐎🐎🐎 avg flow time within 1.9128 seconds, delta to last 2 avg.: +40%
  • 🐎🐎🐎🐎 import jina within 0.4564 seconds, delta to last 2 avg.: +37%

Breakdown

Version Index QPS Query QPS Avg Flow Time (s) Import Time (s)
current 861 36 1.9128 0.4564
2.7.0 1146 50 1.2455 0.3558
2.6.4 1701 31 1.4816 0.3093

Backed by latency-tracking. Further commits will update this comment.

Copy link
Member

@alexcg1 alexcg1 left a comment

Choose a reason for hiding this comment

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

Suggest running the whole doc through grammarly to pick up anything I may have missed

docs/get-started/comparing-to-alternatives.md Outdated Show resolved Hide resolved
docs/get-started/comparing-to-alternatives.md Outdated Show resolved Hide resolved
docs/get-started/comparing-to-alternatives.md Outdated Show resolved Hide resolved
docs/get-started/comparing-to-alternatives.md Outdated Show resolved Hide resolved
docs/get-started/comparing-to-alternatives.md Outdated Show resolved Hide resolved
docs/get-started/comparing-to-alternatives.md Outdated Show resolved Hide resolved
docs/get-started/comparing-to-alternatives.md Outdated Show resolved Hide resolved
docs/get-started/comparing-to-alternatives.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
JoanFM and others added 8 commits February 8, 2022 12:39
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
@github-actions github-actions bot added the area/core This issue/PR affects the core codebase label Feb 9, 2022
@codecov
Copy link

codecov bot commented Feb 9, 2022

Codecov Report

Merging #4254 (e12f4cc) into master (bfd5357) will decrease coverage by 9.62%.
The diff coverage is 46.73%.

❗ Current head e12f4cc differs from pull request most recent head c9e2e14. Consider uploading reports for the commit c9e2e14 to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4254      +/-   ##
==========================================
- Coverage   87.73%   78.11%   -9.63%     
==========================================
  Files         113      114       +1     
  Lines        8254     8324      +70     
==========================================
- Hits         7242     6502     -740     
- Misses       1012     1822     +810     
Flag Coverage Δ
daemon 42.03% <21.73%> (-0.18%) ⬇️
jina 77.18% <46.73%> (-9.75%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...a/orchestrate/deployments/config/docker_compose.py 0.00% <0.00%> (-100.00%) ⬇️
jina/orchestrate/deployments/config/helper.py 0.00% <0.00%> (-96.16%) ⬇️
jina/orchestrate/deployments/config/k8s.py 0.00% <0.00%> (-100.00%) ⬇️
jina/parsers/flow.py 100.00% <ø> (ø)
jina/parsers/orchestrate/base.py 100.00% <ø> (ø)
jina/parsers/orchestrate/runtimes/worker.py 100.00% <ø> (ø)
jina/orchestrate/flow/base.py 75.83% <55.55%> (-15.23%) ⬇️
jina/clients/mixin.py 87.03% <75.00%> (-3.44%) ⬇️
jina/parsers/create.py 83.33% <83.33%> (ø)
jina/excepts.py 100.00% <100.00%> (ø)
... and 34 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 29fec50...c9e2e14. Read the comment docs.

hanxiao and others added 7 commits February 15, 2022 12:50
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
@github-actions
Copy link

📝 Docs are deployed on https://docs3_0--jina-docs.netlify.app 🎉

1 similar comment
@github-actions
Copy link

📝 Docs are deployed on https://docs3_0--jina-docs.netlify.app 🎉

@github-actions
Copy link

📝 Docs are deployed on https://docs3_0--jina-docs.netlify.app 🎉

1 similar comment
@github-actions
Copy link

📝 Docs are deployed on https://docs3_0--jina-docs.netlify.app 🎉

Copy link
Member

@CatStark CatStark left a comment

Choose a reason for hiding this comment

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

style

JoanFM and others added 4 commits February 15, 2022 13:19
Co-authored-by: CatStark <susana.guzman@jina.ai>
Co-authored-by: CatStark <susana.guzman@jina.ai>
@@ -1,8 +1,7 @@
from jina import Executor, DocumentArray, requests
from jina import Executor, requests, DocumentArray
Copy link
Member Author

Choose a reason for hiding this comment

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

we want to import DocumentArray from docarray

@hanxiao hanxiao merged commit 07e2ef0 into master Feb 15, 2022
@hanxiao hanxiao deleted the docs3_0 branch February 15, 2022 12:38
@github-actions
Copy link

📝 Docs are deployed on https://docs3_0--jina-docs.netlify.app 🎉

1 similar comment
@github-actions
Copy link

📝 Docs are deployed on https://docs3_0--jina-docs.netlify.app 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cli This issue/PR affects the command line interface area/core This issue/PR affects the core codebase area/docs This issue/PR affects the docs area/housekeeping This issue/PR is housekeeping component/resource size/XL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet