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

docs: reference add options in exec page #4037

Merged
merged 2 commits into from
Dec 7, 2021
Merged

docs: reference add options in exec page #4037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31692b1
docs: reference add options in exec page
cristianmtr Dec 7, 2021
96b0560
docs: update CONTRIBUTING with instructions
cristianmtr Dec 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,15 @@ Good docs make developers happy, and we love happy developers! We've got a few d
* Tutorials/examples
* Docstrings in Python functions in RST format - generated by Sphinx

### Building documentation locally

In order to build the documentation on your local machine:

```bash
cd docs
bash makedoc.sh local-only
```


## 🙏 Thank You

Expand Down
3 changes: 2 additions & 1 deletion docs/fundamentals/executor/executor-built-in-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,8 @@ different purposes.
- **`.metas` are statically defined.** "Static" means, e.g. from hard-coded value in the code, from a YAML file.
- **`.runtime_args` are dynamically determined during runtime.** Means that you don't know the value before running
the `Executor`, e.g. `pea_id`, `replicas`, `replica_id`. Those values are often related to the system/network
environment around the `Executor`, and less about the `Executor` itself.
environment around the `Executor`, and less about the `Executor` itself. They are usually set with the {meth}`~jina.flow.base.Flow.add`
method. See the list of options [here](https://docs.jina.ai/cli/#executor).

The following fields are valid for `metas` and `runtime_args`:

Expand Down