Improve nested fields documentation #784
Merged
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
The Field Reuse section of docs was not documenting nested fields correctly. For example, if interface can be nested under `observer.ingress` and `observer.egress`, the docs would display `observer.interface.*`, instead of `observer.ingress.interface.*` and `observer.egress.interface.*`. This patch improves the docs by adding the full nesting path.
webmat
approved these changes
Mar 23, 2020
There was a problem hiding this comment.
Oh, nice catch! Thanks for submitting this, @adriansr
I'll merge and backport to 1.5, to fix the public docs ASAP.
I'll also open an issue to fix this upstream in ecs_nested.yml. The nestings array in there is now misleading, and should better capture what you've fixed for asciidoc. But fixing the docs is more pressing for now, so we'll address separately.
webmat
pushed a commit
to webmat/ecs
that referenced
this pull request
Mar 23, 2020
The Field Reuse section of docs was not documenting nested fields correctly. For example, if interface can be nested under `observer.ingress` and `observer.egress`, the docs would display `observer.interface.*`, instead of `observer.ingress.interface.*` and `observer.egress.interface.*`. This patch improves the docs by adding the full nesting path.
This was referenced Mar 23, 2020
webmat
pushed a commit
that referenced
this pull request
Mar 23, 2020
The Field Reuse section of docs was not documenting nested fields correctly. For example, if interface can be nested under `observer.ingress` and `observer.egress`, the docs would display `observer.interface.*`, instead of `observer.ingress.interface.*` and `observer.egress.interface.*`. This patch improves the docs by adding the full nesting path. Co-authored-by: Adrian Serrano
webmat
pushed a commit
to webmat/ecs
that referenced
this pull request
Mar 23, 2020
webmat
pushed a commit
to webmat/ecs
that referenced
this pull request
Mar 23, 2020
webmat
pushed a commit
that referenced
this pull request
Mar 26, 2020
webmat
pushed a commit
to webmat/ecs
that referenced
this pull request
Mar 26, 2020
webmat
pushed a commit
that referenced
this pull request
Mar 26, 2020
dcode
pushed a commit
to dcode/ecs
that referenced
this pull request
Apr 15, 2020
The Field Reuse section of docs was not documenting nested fields correctly. For example, if interface can be nested under `observer.ingress` and `observer.egress`, the docs would display `observer.interface.*`, instead of `observer.ingress.interface.*` and `observer.egress.interface.*`. This patch improves the docs by adding the full nesting path.
dcode
pushed a commit
to dcode/ecs
that referenced
this pull request
Apr 15, 2020
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.
The Field Reuse section of docs was not documenting nested fields correctly.
For example, if interface can be nested under
observer.ingressandobserver.egress, the docs would displayobserver.interface.*, instead ofobserver.ingress.interface.*andobserver.egress.interface.*.This patch improves the docs by adding the full nesting path.
Before:
After: