Skip to content

Add TLDR example to USAGE.md and full example in usage-example/#1036

Merged
webmat merged 4 commits intoelastic:masterfrom
webmat:tldr-usage-example
Oct 19, 2020
Merged

Add TLDR example to USAGE.md and full example in usage-example/#1036
webmat merged 4 commits intoelastic:masterfrom
webmat:tldr-usage-example

Conversation

@webmat
Copy link
Copy Markdown
Contributor

@webmat webmat commented Oct 19, 2020

This is 99% documentation.

There's one small adjustment to the generator.py script, to avoid creating an empty docs/ directory, since we don't generate it when --include or --subset are being used.

@webmat webmat self-assigned this Oct 19, 2020
@webmat webmat requested a review from ebeahan October 19, 2020 14:33
@webmat
Copy link
Copy Markdown
Contributor Author

webmat commented Oct 19, 2020

@ebeahan I almost decided to create the directory with the example as a personal gist. But this may not stand the test of time as well.

I wouldn't want this subdirectory to be auto-generated on each build, so right now it's a one off addition. When we make changes relevant to managing custom fields, we can simply run the command in usage-example/README.md again and commit the changes. WDYT?

Copy link
Copy Markdown
Member

@ebeahan ebeahan left a comment

Choose a reason for hiding this comment

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

There's one small adjustment to the generator.py script, to avoid creating an empty docs/ directory, since we don't generate it when --include or --subset are being used.

👏

When we make changes relevant to managing custom fields, we can simply run the command in usage-example/README.md again and commit the changes. WDYT?

👍 - I think that's a fine place to start.

@webmat webmat merged commit 9704ec3 into elastic:master Oct 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants