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.

Sign up for GitHub

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

Jump to bottom

docs(contributing/callbacks): fix links and formatting #5571

Merged
merged 10 commits into from Jan 16, 2023
Merged

docs(contributing/callbacks): fix links and formatting #5571

merged 10 commits into from Jan 16, 2023

Conversation

alexcg1
Copy link
Member

@alexcg1 alexcg1 commented Jan 3, 2023 •
edited

Some small fixes:

  • CONTRIBUTING - fix docs example links, remove "Alex" stuff

  • callbacks - add backticks around relevant text

  • README - fix links

  • check and update documentation. See guide and ask the team.

@alexcg1 alexcg1 added the area/docs This issue/PR affects the docs label Jan 3, 2023
@alexcg1 alexcg1 self-assigned this Jan 3, 2023
@github-actions github-actions bot added the size/M label Jan 3, 2023
@codecov
Copy link

codecov bot commented Jan 3, 2023 •
edited

Codecov Report

Merging #5571 (536296f) into master (a5ef69b) will increase coverage by 0.87%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5571      +/-   ##
==========================================
+ Coverage   87.11%   87.98%   +0.87%     
==========================================
  Files         124      124              
  Lines       10048    10048              
==========================================
+ Hits         8753     8841      +88     
+ Misses       1295     1207      -88
Flag Coverage Δ
jina 87.98% <ø> (+0.87%) ⬆️

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

Impacted Files Coverage Δ
jina/orchestrate/flow/base.py 90.08% <0.00%> (+0.61%) ⬆️
jina/serve/networking.py 90.45% <0.00%> (+1.23%) ⬆️
jina/helper.py 80.93% <0.00%> (+1.28%) ⬆️
...ina/serve/runtimes/gateway/graph/topology_graph.py 99.48% <0.00%> (+1.54%) ⬆️
jina/serve/streamer.py 93.33% <0.00%> (+2.66%) ⬆️
jina/clients/base/http.py 95.83% <0.00%> (+2.77%) ⬆️
jina/serve/runtimes/gateway/http/app.py 97.81% <0.00%> (+2.91%) ⬆️
...estrate/deployments/install_requirements_helper.py 67.02% <0.00%> (+3.19%) ⬆️
jina/clients/base/grpc.py 91.17% <0.00%> (+4.90%) ⬆️
jina/serve/runtimes/gateway/request_handling.py 95.32% <0.00%> (+6.54%) ⬆️
... and 2 more

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

@alexcg1 alexcg1 force-pushed the docs-fixes-links-formatting branch from 05e3cd0 to b16ced9 Compare January 3, 2023 14:25
@alexcg1 alexcg1 requested a review from hanxiao as a code owner January 3, 2023 14:50
@alexcg1 alexcg1 force-pushed the docs-fixes-links-formatting branch from a7e1a4a to 495cc79 Compare January 3, 2023 15:15
samsja
samsja reviewed Jan 4, 2023
View reviewed changes
docs/proto/docs.md Outdated
Comment on lines 1 to 3
# Protocol Documentation
<a name="top"></a>

Copy link
Contributor

Choose a reason for hiding this comment

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

Why the modification on the proto docs ? It looks like the file was commited by mistake or is from an old version

Copy link
Member Author

Choose a reason for hiding this comment

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

Damn, looks like a mistake. I'll try to fix

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed that commit. For some reason GitHub is saying I re-added all the other commits again 🤷

@alexcg1
docs(contributing): fix slack link
aa21d32
@alexcg1
docs(readme): break out install links
62130aa 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1
docs(readme): update glossary link
07e5d44 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1
docs: fix websocket capitalization to reflect official name
3414236 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1
docs: fix macos capitalization to reflect latest official conventions
ea5185d 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1 alexcg1 force-pushed the docs-fixes-links-formatting branch from b0651a5 to ea5185d Compare January 4, 2023 09:15
@github-actions github-actions bot added the size/S label Jan 4, 2023
@alexcg1
Copy link
Member Author

alexcg1 commented Jan 4, 2023

Hmmm...k8s ci constantly timing out

alaeddine-13
alaeddine-13 previously approved these changes Jan 5, 2023
View reviewed changes
@alexcg1
Copy link
Member Author

alexcg1 commented Jan 6, 2023

Can I get another approval? Then I think we can merge

@samsja @JohannesMessner

samsja
samsja previously approved these changes Jan 6, 2023
View reviewed changes
@alexcg1
Copy link
Member Author

alexcg1 commented Jan 10, 2023

@hanxiao can you review?

@github-actions github-actions bot dismissed stale reviews from samsja and alaeddine-13 via b831eab January 10, 2023 08:08
@github-actions
Copy link

📝 Docs are deployed on https://docs-fixes-links-formatting--jina-docs.netlify.app 🎉

@JoanFM JoanFM merged commit 6eb4078 into master Jan 16, 2023
@JoanFM JoanFM deleted the docs-fixes-links-formatting branch January 16, 2023 15:16
@alaeddine-13 alaeddine-13 mentioned this pull request Feb 9, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alaeddine-13 alaeddine-13 alaeddine-13 left review comments

@samsja samsja samsja left review comments

@JohannesMessner JohannesMessner Awaiting requested review from JohannesMessner

@hanxiao hanxiao Awaiting requested review from hanxiao hanxiao is a code owner

Assignees

@alexcg1 alexcg1

Labels
area/docs This issue/PR affects the docs size/M size/S
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@alexcg1 @alaeddine-13 @samsja @JoanFM @jina-bot