[DOCS] Create documentation for fields.yml (#6049) #12505
Conversation
|
Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually? |
|
Thanks for your contribution. WRT writing style, we prefer to avoid passive voice when possible (active verbs are easier to read). Also, you should add line breaks before your code sections (for example, before line 7). We're migrating to asciidoctor, which is less permissive than asciidoc, so it's best to be on the safe side. I'd like to offer more editorial feedback, but I can't right now. If this doesn't get merged before I come back to it, I'll submit a follow-up edit. Thanks again for doing this! |
| copy_to: full_name | ||
| description: > | ||
| The surname. | ||
| multi_fields: <1> |
There was a problem hiding this comment.
Both surname and forenames here are themselves keyword types, which would make this redundant, right? The description above also describes using this on text fields, not keywords. Perhaps this section should use a different example field that would more naturally be of type text.
There was a problem hiding this comment.
@bestpath-gb Will you be able to update the example as suggested here? I appreciate the effort that you put into creating this PR and would like to help you get this merged.
There was a problem hiding this comment.
Thanks for the feedback. Sorry for the delay in getting back to this. I'm hoping to review and update the examples this week.
There was a problem hiding this comment.
That was a great catch, @faec . I've updated the examples based on the Elasticsearch reference for those mapping parameters.
|
jenkins test this please |
|
I'm adding the |
dedemorton
added
the
needs_edit
bestpath-gb
force-pushed
the
doc/fields-yaml
branch
from
2104342 to
90b35fe
Compare
|
@elasticmachine run elasticsearch-ci/docs |
|
Sorry I haven't been able to edit this yet. I think it's best to merge the PR since it's technically correct. I'll follow up with edits in a separate PR. Just launched the doc build. When it passes, I will merge. Thanks again for your contribution. My apologies that it's taken me awhile to get back to this. |
dedemorton
added
needs_backport
|
I've created a meta issue to track the content that requires an edit, so I'm removing the needs_edit |
dedemorton
removed
the
needs_edit
* [DOCS] Create documentation for fields.yml (#6049) (#12505) * [docs] Edit docs about field mappings (#17740) Co-authored-by: George Bridgeman <[email protected]>
* [DOCS] Create documentation for fields.yml (#6049) (#12505) * [docs] Edit docs about field mappings (#17740) Co-authored-by: George Bridgeman <[email protected]>
* [DOCS] Create documentation for fields.yml (elastic#6049) (elastic#12505) * [docs] Edit docs about field mappings (elastic#17740) Co-authored-by: George Bridgeman <[email protected]>
Add a new documentation page for
_meta/fields.yml. This mentions what I'd consider most of the commonly used options, with a few examples.