Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak note about 'IDs' being keyword to also mention 'codes' #157

Merged
merged 2 commits into from
Nov 1, 2018

Conversation

webmat
Copy link
Contributor

@webmat webmat commented Oct 29, 2018

No description provided.

@webmat webmat requested a review from ruflin October 29, 2018 15:09
@webmat webmat self-assigned this Oct 29, 2018
README.md Outdated
@@ -503,11 +503,12 @@ of a breaking change with these two widely used fields in Beats.
Any future field that will be indexed for full text search in ECS will however
follow the multi-field convention where `text` indexing is nested in the multi-field.

### IDs are keywords not integers
### IDs and codes are keywords, not integers
Copy link
Member

Choose a reason for hiding this comment

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

Are you thinking of some specific fields here?

Copy link
Contributor Author

@webmat webmat Oct 29, 2018

Choose a reason for hiding this comment

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

Yes, error codes. Came up during a discussion with @graphaelli over on #154. Just thought I would flesh out this little section here.

@webmat webmat added the review label Oct 30, 2018
@ruflin
Copy link
Member

ruflin commented Oct 31, 2018

The reason I'm hesitant to merge this is because there are some instances like status_code where things are long and as I see this as a good thing. Perhaps it can be rephrased to "in most cases".

@webmat
Copy link
Contributor Author

webmat commented Oct 31, 2018

Gotcha. I'll tweak accordingly.

@webmat
Copy link
Contributor Author

webmat commented Oct 31, 2018

Reworded. Although I find this a bit wordy.

Copy link
Member

@ruflin ruflin left a comment

Choose a reason for hiding this comment

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

LGTM. I think we probably go into too much details here but now that it's already written ...

@webmat
Copy link
Contributor Author

webmat commented Nov 1, 2018

I agree README is getting verbose. But my plan is definitely to split off some of these discussions into secondary documentation files, to streamline the readme again.

@webmat webmat merged commit 2cfa506 into elastic:master Nov 1, 2018
@webmat webmat deleted the codes-keyword branch November 1, 2018 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants