Skip to content

[Mappings editor] Improve data type descriptions. #54844

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.

Sign up for GitHub

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

Merged
cjcenizal merged 3 commits into from
Jan 14, 2020
Merged

[Mappings editor] Improve data type descriptions. #54844

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
91f73fa
Improve data type descriptions.
cjcenizal Jan 14, 2020
86bc846
Refine token count.
cjcenizal Jan 14, 2020
db7e4d6
Apply feedback.
cjcenizal Jan 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions ...ndex_management/public/app/components/mappings_editor/constants/data_types_definition.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export const TYPE_DEFINITION: { [key in DataType]: DataTypeDefinition } = {
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.keywordLongDescription"
defaultMessage="Keyword fields support search by their exact value. This data type is useful for filtering, sorting, and aggregations. To index full-text content, such as an email body, use the {textType}."
defaultMessage="Keyword fields support searching for an exact value and are useful for filtering, sorting, and aggregations. To index full-text content, such as an email body, use the {textType}."
values={{
textType: (
<EuiLink href={documentationService.getTypeDocLink('text')} target="_blank">
Expand Down Expand Up @@ -417,7 +417,7 @@ export const TYPE_DEFINITION: { [key in DataType]: DataTypeDefinition } = {
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.denseVectorLongDescription"
defaultMessage="Dense vector fields store dense vectors of float values. This data type is useful for document scoring."
defaultMessage="Dense vector fields store vectors of float values, useful for document scoring."
/>
</p>
),
Expand Down Expand Up @@ -568,7 +568,7 @@ export const TYPE_DEFINITION: { [key in DataType]: DataTypeDefinition } = {
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.completionSuggesterLongDescription"
defaultMessage="Completion suggester fields support autocomplete functionality. This data type uses data structures to enable fast lookups, but are costly to build and stored in-memory."
defaultMessage="Completion suggester fields support autocomplete, but require special data structures that occupy memory and build slowly."
/>
</p>
),
Expand All @@ -585,7 +585,7 @@ export const TYPE_DEFINITION: { [key in DataType]: DataTypeDefinition } = {
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.tokenCountLongDescription"
defaultMessage="Token count fields accept string values. These values are analyzed, then the number of tokens in the string are indexed."
defaultMessage="Token count fields accept string values. These values are analyzed, and the number of tokens in the string are indexed."
/>
</p>
),
Expand Down Expand Up @@ -620,7 +620,7 @@ export const TYPE_DEFINITION: { [key in DataType]: DataTypeDefinition } = {
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.aliasLongDescription"
defaultMessage="Alias fields accept an alternative name for a field in the index. Aliases can be used in place of the target field in search requests."
defaultMessage="Alias fields accept an alternative name for a field, which you can use in search requests."
/>
</p>
),
Expand All @@ -637,7 +637,7 @@ export const TYPE_DEFINITION: { [key in DataType]: DataTypeDefinition } = {
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.searchAsYouTypeLongDescription"
defaultMessage="Search-as-you-type fields supports as-you-type search by breaking strings into a series of subfields. Both prefix completion and infix completion are supported."
defaultMessage="Search-as-you-type fields break strings into subfields for search suggestions, and will match terms at any position in the string."
/>
</p>
),
Expand All @@ -654,7 +654,7 @@ export const TYPE_DEFINITION: { [key in DataType]: DataTypeDefinition } = {
<p>
<FormattedMessage
id="xpack.idxMgmt.mappingsEditor.dataType.flattenedLongDescription"
defaultMessage="Flattened fields map an entire field as a single object. This data type is useful for indexing objects with a large or unknown number of unique keys. Flattened fields only support basic queries."
defaultMessage="Flattened fields map an object as a single field and are useful for indexing objects with a large or unknown number of unique keys. Flattened fields support basic queries only."
/>
</p>
),
Expand Down