docs: fix urls to docs.docarray.org by alexcg1 · Pull Request #1101 · docarray/docarray

alexcg1 · 2023-02-08T12:05:24Z

WIP. Replacing all occurrences of docarray.jina.ai with docs.docarray.org

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

Goals:

...
...
check and update documentation, if required. See guide

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

alexcg1 · 2023-02-08T12:07:03Z

Several non-markdown files also contain the old URL. I want to confirm it's safe to change these (should be safe if migration was done comprehensively, but want to be sure)

rg docarray.jina.ai

setup.py
43:        # req usage, please see https://docarray.jina.ai/#install
152:        'Documentation': 'https://docarray.jina.ai',

docs/conf.py
48:html_baseurl = 'https://docarray.jina.ai'
164:ogp_site_url = 'https://docarray.jina.ai/'
165:ogp_image = 'https://docarray.jina.ai/_static/banner.png'

docs/html_extra/robots.txt
2:sitemap: https://docarray.jina.ai/sitemap.xml

tests/unit/array/mixins/test_pushpull.py
194:                        image='https://docarray.jina.ai/_images/apple.png',

scripts/docstrings_lint.sh
39:  echo 'failure. make sure to check the guide for docstrings: https://docarray.jina.ai/chapters/docstring.html'

docarray/array/storage/qdrant/find.py
138:        For more information: https://docarray.jina.ai/advanced/document-store/qdrant/#qdrant

docarray/proto/build-proto.sh
25:      "https://docarray.jina.ai/"

docarray/array/mixins/traverse.py
62:                f'`path`:{path} is invalid, please refer to https://docarray.jina.ai/fundamentals/documentarray/access-elements/#index-by-nested-structure'
147:                    f'`path`:{path} is invalid, please refer to https://docarray.jina.ai/fundamentals/documentarray/access-elements/#index-by-nested-structure'

codecov-commenter · 2023-02-08T12:12:10Z

Codecov Report

Base: 83.06% // Head: 70.32% // Decreases project coverage by -12.75% ⚠️

Coverage data is based on head (85c45ca) compared to base (dda4106).
Patch has no changes to coverable lines.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #1101       +/-   ##
===========================================
- Coverage   83.06%   70.32%   -12.75%     
===========================================
  Files         155      155               
  Lines        8061     8061               
===========================================
- Hits         6696     5669     -1027     
- Misses       1365     2392     +1027

Flag	Coverage Δ
docarray	`70.32% <ø> (-12.75%)`	⬇️

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

Impacted Files	Coverage Δ
docarray/array/mixins/post.py	`17.07% <0.00%> (-78.05%)`	⬇️
docarray/array/mixins/delitem.py	`11.11% <0.00%> (-77.78%)`	⬇️
docarray/array/mixins/io/csv.py	`23.07% <0.00%> (-66.67%)`	⬇️
docarray/array/queryset/parser.py	`21.66% <0.00%> (-66.67%)`	⬇️
docarray/array/mixins/plot.py	`7.79% <0.00%> (-60.18%)`	⬇️
docarray/array/mixins/sample.py	`45.45% <0.00%> (-54.55%)`	⬇️
docarray/array/storage/base/getsetdel.py	`52.28% <0.00%> (-40.53%)`	⬇️
docarray/array/storage/elastic/find.py	`58.18% <0.00%> (-38.19%)`	⬇️
docarray/array/storage/sqlite/getsetdel.py	`60.00% <0.00%> (-37.78%)`	⬇️
docarray/array/storage/base/backend.py	`52.08% <0.00%> (-37.51%)`	⬇️
... and 54 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

alexcg1 · 2023-02-08T13:07:30Z

@samsja can you respond to comment above?

alexcg1 · 2023-02-08T13:22:10Z

Several non-markdown files also contain the old URL. I want to confirm it's safe to change these (should be safe if migration was done comprehensively, but want to be sure)

rg docarray.jina.ai

setup.py
43:        # req usage, please see https://docarray.jina.ai/#install
152:        'Documentation': 'https://docarray.jina.ai',

docs/conf.py
48:html_baseurl = 'https://docarray.jina.ai'
164:ogp_site_url = 'https://docarray.jina.ai/'
165:ogp_image = 'https://docarray.jina.ai/_static/banner.png'

docs/html_extra/robots.txt
2:sitemap: https://docarray.jina.ai/sitemap.xml

tests/unit/array/mixins/test_pushpull.py
194:                        image='https://docarray.jina.ai/_images/apple.png',

scripts/docstrings_lint.sh
39:  echo 'failure. make sure to check the guide for docstrings: https://docarray.jina.ai/chapters/docstring.html'

docarray/array/storage/qdrant/find.py
138:        For more information: https://docarray.jina.ai/advanced/document-store/qdrant/#qdrant

docarray/proto/build-proto.sh
25:      "https://docarray.jina.ai/"

docarray/array/mixins/traverse.py
62:                f'`path`:{path} is invalid, please refer to https://docarray.jina.ai/fundamentals/documentarray/access-elements/#index-by-nested-structure'
147:                    f'`path`:{path} is invalid, please refer to https://docarray.jina.ai/fundamentals/documentarray/access-elements/#index-by-nested-structure'

@samsja I mean this comment. Am I good to change all of the non-markdown files? I want to be sure nothing will break

samsja · 2023-02-08T13:38:14Z

I want to be sure nothing will break
@alexcg1 I check every link in the code part as well. It is working

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

alexcg1 · 2023-02-08T15:09:22Z

Cool. Ready for review

github-actions · 2023-02-08T15:17:53Z

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

docs: fix urls to docs.docarray.org in all markdown files

85c45ca

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

github-actions bot added size/s area/docs labels Feb 8, 2023

alexcg1 changed the title ~~docs: fix urls to docs.docarray.org in all markdown files~~ docs: fix urls to docs.docarray.org Feb 8, 2023

alexcg1 requested a review from samsja February 8, 2023 12:07

samsja approved these changes Feb 8, 2023

View reviewed changes

fix: replace all instances of docarray.jina.ai to docs.docarray.org

2c33773

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

alexcg1 marked this pull request as ready for review February 8, 2023 15:09

github-actions bot added area/core area/setup area/testing component/array component/proto labels Feb 8, 2023

JoanFM approved these changes Feb 8, 2023

View reviewed changes

JoanFM merged commit 34403f7 into main Feb 8, 2023

JoanFM deleted the docs-fix-urls branch February 8, 2023 16:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fix urls to docs.docarray.org#1101

docs: fix urls to docs.docarray.org#1101
JoanFM merged 2 commits intomainfrom
docs-fix-urls

alexcg1 commented Feb 8, 2023

Uh oh!

alexcg1 commented Feb 8, 2023

Uh oh!

codecov-commenter commented Feb 8, 2023 •

edited

Loading

Uh oh!

alexcg1 commented Feb 8, 2023

Uh oh!

alexcg1 commented Feb 8, 2023

Uh oh!

samsja commented Feb 8, 2023

Uh oh!

alexcg1 commented Feb 8, 2023

Uh oh!

github-actions bot commented Feb 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

alexcg1 commented Feb 8, 2023

Uh oh!

alexcg1 commented Feb 8, 2023

Uh oh!

codecov-commenter commented Feb 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

alexcg1 commented Feb 8, 2023

Uh oh!

alexcg1 commented Feb 8, 2023

Uh oh!

samsja commented Feb 8, 2023

Uh oh!

alexcg1 commented Feb 8, 2023

Uh oh!

github-actions bot commented Feb 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Feb 8, 2023 •

edited

Loading