docs: daemon in readme #3122
docs: daemon in readme #3122
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3122 +/- ##
==========================================
- Coverage 89.25% 89.10% -0.16%
==========================================
Files 145 145
Lines 9928 9928
==========================================
- Hits 8861 8846 -15
- Misses 1067 1082 +15
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Latency summaryCurrent PR yields:
Breakdown
Backed by latency-tracking. Further commits will update this comment. |
30b1b0e to
7b98a14
Compare
|
@hanxiao this needs your approval |
.github/2.0/cookbooks/Daemon.md
Outdated
|
|
||
| You wouldn't need to create remote Peas/Pods directly yourself. You can use the below code by passing `host` & `port_expose` to an executor with the Flow. Internally it uses `JinaD` for remote management. | ||
| You wouldn't need to create remote Peas/Pods directly yourself. You can use the below code by passing `host` & `port_expose` to an executor with a Flow. Internally it uses `JinaD` for remote management. |
There was a problem hiding this comment.
- Executor
- Do we mention Peas/Pods elsewhere? I thought they were mostly invisible to users now
There was a problem hiding this comment.
Advanced concepts for JinaD would still need to separate Peas from Pods, hence need to be defined separately. I'm changing the top-level name to Executor
.github/2.0/cookbooks/Daemon.md
Outdated
| <details> | ||
| <summary><strong>Create a Flow (<a href="https://api.jina.ai/daemon/#operation/_create_flows_post">redoc</a>)</strong></summary> | ||
|
|
||
| This creates a new container using the base image & network defined by `workspace_id` & starts a Flow inside the container. Only the ports needed for external communication are mapped to local. Make sure you've added all your config files while creating the workspace in the previous step. |
There was a problem hiding this comment.
- Let's stick to "and" instead of "&" for consistency
| <details> | ||
| <summary>Example response</summary> | ||
|
|
||
| ```text |
There was a problem hiding this comment.
Can we have JSON syntax highlight?
There was a problem hiding this comment.
This actually returns a python dict, and adding json highlighting in the markdown looks weird for python dict.
| - ☁️ `JinaD`: manage & deploy Jina on remote | ||
| - [Server & Client](.github/2.0/cookbooks/Daemon.md#jinad-daemon) | ||
| - [Remote Executors](.github/2.0/cookbooks/Daemon.md#restful-executors) | ||
| - [Remote Flows](.github/2.0/cookbooks/Daemon.md#restful-flows) | ||
| - 📓 [Developer Reference](https://docs.jina.ai) | ||
| - 🧼 [Clean & Efficient Coding in Jina](.github/2.0/cookbooks/CleanCode.md) |
There was a problem hiding this comment.
Just to be clear, I'm fine with "&" in bullet links (keeps them short). Only in paragraphs let's expand to "and"
66e6fa6
Community feedback: JinaD docs are missing in readme.
In this PR, added a section in tutorials about JinaD