Introduction of an optional short field description #330
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
webmat
force-pushed
the
short-description
branch
2 times, most recently
from
6c47109 to
5f50b7e
Compare
MikePaquette
approved these changes
Feb 22, 2019
|
@dedemorton Here's @webmat 's work on toward giving us a shortdesc. |
webmat
commented
Feb 22, 2019
| @@ -20,7 +20,7 @@ | |||
| type: keyword | |||
| short: Name of the cloud provider. | |||
| description: > | |||
| Name of the cloud provider. Example values are aws, azure, gce, or | |||
| Name of the cloud provider. Example values are aws, azure, gcp, or | |||
webmat
commented
Feb 22, 2019
webmat
commented
Feb 22, 2019
Also: - Replace incorrect `ec2` example in `cloud.provider` with `aws`. - Add pointer in description of `http` field set to `url` field set.
This will improve consistency with how we've been formatting field definitions.
Comes with minor description adjustments as well.
typo - "field" to "fields" in message description
There's now two fixes in the field description
webmat
force-pushed
the
short-description
branch
from
55a7bd6 to
0022671
Compare
| @@ -17,8 +18,9 @@ | |||
| level: extended | |||
| example: ec2 | |||
There was a problem hiding this comment.
@webmat Sorry I just saw this PR for some reason... Thanks for making the changes! I just found this ec2 still in provider example. This probably should be aws instead.
There was a problem hiding this comment.
Oh jeez, we fixed the example in the text, but not in the example field, haha! Thanks for pointing it out 👍
webmat
pushed a commit
to webmat/ecs
that referenced
this pull request
Feb 28, 2019
PR elastic#330 only fixed the text in the description :-)
webmat
pushed a commit
to webmat/ecs
that referenced
this pull request
Mar 4, 2019
PR elastic#330 only fixed the text in the description :-)
webmat
added a commit
that referenced
this pull request
Mar 5, 2019
PR #330 only fixed the text in the description :-)
webmat
added a commit
to webmat/ecs
that referenced
this pull request
Mar 5, 2019
…n to fields and fieldsets (elastic#330) Additional things were fixed, while playing in these descriptions: - Some definitions were adjusted in terms of wording and in terms of separating paragraphs (double \n) - `cloud.provider` examples fixed to mention the actual provider, not a service like "ec2" - Add pointer in `http` field description to `url` - Lowercased the `log.level` examples. The field doesn't technically have the requirement, but at least we can start guiding in that direction for the future.
webmat
added a commit
that referenced
this pull request
Mar 5, 2019
…elds and fieldsets (#330) (#362) Backport of PR #330 to 1.0 branch. Original message: Additional things were fixed, while playing in these descriptions: - Some definitions were adjusted in terms of wording and in terms of separating paragraphs (double \n) - `cloud.provider` examples fixed to mention the actual provider, not a service like "ec2" - Add pointer in `http` field description to `url` - Lowercased the `log.level` examples. The field doesn't technically have the requirement, but at least we can start guiding in that direction for the future.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a
short:description to the YAML format for defining fields. All fields who need a short description for easy display in cramped spaces now have one.This PR does not address the outputs which would benefit from this new short description. This should be addressed in a separate PR per output. PRs welcome, BTW ;-)
In reviewing all of these field descriptions, some main descriptions were adjusted as well.
A few other concerns have been addressed also:
ec2example incloud.providerwithaws.httpfield set tourlfield set.I can extract to their own PR, if needed.
Questions