Skip to content

Commit

Permalink
chore(docs): reframe sentences
Browse files Browse the repository at this point in the history
  • Loading branch information
subbuv26 committed Oct 16, 2023
1 parent e65026f commit 3bd8dee
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions docs/concepts/jcloud/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -486,8 +486,6 @@ jc job logs myjob1 -f rich-husky-af14064067

### Deploy

In Jina's idiom, a project is a [Deployment](https://docs.jina.ai/concepts/orchestration/Deployment/), which represents an end-to-end task such as indexing, searching or recommending. In this document, we use "project" and "Deployment" interchangeably.

```{caution}
When `jcloud` deploys a deployment it automatically appends the following global arguments to the `deployment.yml`, if not present:
```
Expand All @@ -500,9 +498,9 @@ jcloud:
#### Single YAML file
A self-contained YAML file, consisting of all configuration at the [Deployment](https://docs.jina.ai/concepts/orchestration/deployment/)-level and [Executor](https://docs.jina.ai/concepts/serving/executor/)-level.
A self-contained YAML file, consisting of all configuration information at the [Deployment](https://docs.jina.ai/concepts/orchestration/deployment/)-level and [Executor](https://docs.jina.ai/concepts/serving/executor/)-level.
> A Deployment's `uses` must follow the format `jinaai+docker://<username>/MyExecutor` (from [Executor Hub](https://cloud.jina.ai)) to avoid any local file dependencies:
> A Deployment's `uses` parameter must follow the format `jinaai+docker://<username>/MyExecutor` (from [Executor Hub](https://cloud.jina.ai)) to avoid any local file dependencies:

```yaml
# deployment.yml
Expand All @@ -525,9 +523,9 @@ The Deployment is successfully deployed when you see:
```
---

You will get a Deployment ID, say `pretty-monster-130a5ac952`. This ID is required to manage, view logs and remove the Deployment.
You will get a Deployment ID, for example `pretty-monster-130a5ac952`. This ID is required to manage, view logs, and remove the Deployment.

As this Deployment is deployed with the default gRPC protocol (feel free to change it to `http`), you can use `jina.Client` to access it:
Since this Deployment is deployed with the default gRPC protocol (feel free to change it to `http`), you can use `jina.Client` to access it:

```python
from jina import Client, Document
Expand Down Expand Up @@ -585,7 +583,7 @@ jc deployment list --phase all
```

### Remove Deployments
You can remove a single Deployment, multiple Deployments or even all Deployments by passing different identifiers.
You can remove a single Deployment, multiple Deployments, or even all Deployments by passing different commands to the `jc` executable at the command line.

To remove a single Deployment:

Expand All @@ -605,7 +603,7 @@ To remove all Deployments:
jc deployment remove all
```

By default, removing multiple or all Deployments is an interactive process where you must give confirmation before each Deployment is deleted. To make it non-interactive, set the below environment variable before running the command:
By default, removing all or multiple Deployments is an interactive process where you must give confirmation before each Deployment is deleted. To make it non-interactive, set the below environment variable before running the command:

```bash
export JCLOUD_NO_INTERACTIVE=1
Expand Down

0 comments on commit 3bd8dee

Please sign in to comment.