Remove include_type_name in asciidoc where possible#37568
Merged
cbuescher merged 2 commits intoelastic:masterfrom Jan 18, 2019
Merged
Remove include_type_name in asciidoc where possible#37568cbuescher merged 2 commits intoelastic:masterfrom
include_type_name in asciidoc where possible#37568cbuescher merged 2 commits intoelastic:masterfrom
Conversation
The "include_type_name" parameter was temporarily introduced in elastic#37285 to facilitate moving the default parameter setting to "false" in many places in the documentation code snippets. Most of the places can simply be reverted without causing errors. In this change I looked for asciidoc files that contained the "include_type_name=true" addition when creating new indices but didn't look likey they made use of the "_doc" type for mappings. This is mostly the case e.g. in the analysis docs where index creating often only contains settings. I manually corrected the use of types in some places where the docs still used an explicit type name and not the dummy "_doc" type.
Collaborator
|
Pinging @elastic/es-search |
Member
Author
|
fyi, there are about 159 places left to remove "include_type_name" from the docs, but the changes are quite mechanical. I was trying to do some manually to get a sense of whether it makes sense to write a more complex script for that kind of work or do it by hand, and I think I was able to get it down to about 130 in only 15min. It should be quite fast of you know what to look for and have developed a bit of muscle memory to search/replace the relevant bits. I think we can do the rest in about 2-3h, maybe split that up into two or three PRs. |
colings86
approved these changes
Jan 17, 2019
Contributor
colings86
left a comment
There was a problem hiding this comment.
I left a comment on an indentation issue but otherwise this LGTM
48 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 "include_type_name" parameter was temporarily introduced in #37285 to facilitate
moving the default parameter setting to "false" in many places in the documentation
code snippets. Most of the places can simply be reverted without causing errors.
In this change I looked for asciidoc files that contained the
"include_type_name=true" addition when creating new indices but didn't look
likey they made use of the "_doc" type for mappings. This is mostly the case
e.g. in the analysis docs where index creating often only contains settings. I
manually corrected the use of types in some places where the docs still used an
explicit type name and not the dummy "_doc" type.