Skip to content

Commit

Permalink
docs: replace UUID with NAME (jina-ai#3488)
Browse files Browse the repository at this point in the history
* docs: replace UUID with NAME

* fix: update docs/advanced/hub/push-executor.md

Co-authored-by: Joan Fontanals <[email protected]>
  • Loading branch information
nan-wang and JoanFM authored Sep 29, 2021
1 parent 74ca9e8 commit 3f5ee8e
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/advanced/hub/push-executor.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jina hub push [--public/--private] <path_to_executor_folder>
```


It will return `UUID` & `SECRET`, which you will need when using (if private) or update the Executor later. **Please keep them carefully.**
It will return `NAME` & `SECRET`, which you will need when using (if private) or update the Executor later. **Please keep them carefully.**

You can then visit [the Hub portal](https://hub.jina.ai), click on the "Recent" tab and see your published Executor.

Expand All @@ -36,10 +36,10 @@ Anyone can use any public Executor, but to use a private Executor one must know

## Update published Executors

To override or update a published Executor, you must have both `UUID` and `SECRET`.
To override or update a published Executor, you must have both `NAME` and `SECRET`.

```bash
jina hub push [--public/--private] --force <UUID> --secret <SECRET> <path_to_executor_folder>
jina hub push [--public/--private] --force <NAME> --secret <SECRET> <path_to_executor_folder>
```

(hub_tags)=
Expand All @@ -64,5 +64,5 @@ jina hub push . -t v1.0.0 -t latest # Result in two tags: v1.0.0, latest
If you want to create a new tag for an existing Executor, you can also add the `-t` option here:

```bash
jina hub push [--public/--private] --force <UUID> --secret <SECRET> -t TAG <path_to_executor_folder>
jina hub push [--public/--private] --force <NAME> --secret <SECRET> -t TAG <path_to_executor_folder>
```
2 changes: 1 addition & 1 deletion jina/parsers/hubble/pull.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ def hub_uri(uri: str) -> str:
parser.add_argument(
'uri',
type=hub_uri,
help='The URI of the executor to pull (e.g., jinahub[+docker]://UUID8)',
help='The URI of the executor to pull (e.g., jinahub[+docker]://NAME)',
)
mixin_hub_pull_options_parser(parser)
2 changes: 1 addition & 1 deletion jina/parsers/hubble/push.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def dir_path(string):
gp.add_argument(
'--force',
type=str,
help='If set, push will overwrite the Executor on the Hub that shares the same UUID8 identifier',
help='If set, push will overwrite the Executor on the Hub that shares the same NAME or UUID8 identifier',
)
gp.add_argument(
'--secret',
Expand Down

0 comments on commit 3f5ee8e

Please sign in to comment.