Skip to content

Correct experimental usage example #1045

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

Merged
ebeahan merged 3 commits into from
Oct 22, 2020
Merged

Correct experimental usage example #1045

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57c8267
fix incorrect usage in example command
ebeahan Oct 22, 2020
f7e95e7
document that --include supports passing multiple directory locations
ebeahan Oct 22, 2020
f13db2c
Update USAGE.md
ebeahan Oct 22, 2020
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
6 changes: 6 additions & 0 deletions USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,12 @@ For example, if we defined the following schema definition in a file named `mypr
Unique identifier of the widget.
```

Multiple directory targets can also be provided:

@webmat webmat Oct 22, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ah, I guess I was misunderstanding how to properly pass in multiple directories. I knew the action=append thing would make it possible to pass in the same flag multiple times, but I didn't realize we could just pass in space-separated paths as well.


```
$ python scripts/generator.py --include ../myproject/custom-fields-A/ ../myproject/custom-fields-B --out ../myproject/out/
Comment thread
ebeahan marked this conversation as resolved.
Outdated
```

Generate artifacts using `--include` to load our custom definitions in addition to `--out` to place them in the desired output directory:

```
Expand Down
3 changes: 1 addition & 2 deletions experimental/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ The [experimental/schemas](./schemas) directory contains the YAML files for the
If you use the ECS generator script as described in [USAGE.md](../USAGE.md) to maintain your custom index templates, here's how you can try these experimental changes in your project:

```sh
$ python scripts/generator.py --include experimental/schemas \
--include ../myproject/fields/custom/ \
$ python scripts/generator.py --include experimental/schemas ../myproject/fields/custom/ \
--out ../myproject/fields/generated
```

Expand Down