Proofreading edits, UI text consistency (#24016)

This commit is contained in:
Ryan Keairns 2018-10-16 14:08:13 -05:00 committed by GitHub
parent e79533dec6
commit f59f1ccf1b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
48 changed files with 88 additions and 88 deletions

View file

@ -9,7 +9,7 @@ import header from './header.png';
export const image = () => ({
name: 'image',
displayName: 'Image',
help: 'A static image.',
help: 'A static image',
image: header,
expression: `image dataurl=null mode="contain"
| render`,

View file

@ -13,18 +13,18 @@ export const markdown = () => ({
image: header,
expression: `filters
| demodata
| markdown "### Welcome to the Markdown Element.
| markdown "### Welcome to the Markdown element
Good news! You're already connected to some demo data!
The datatable contains
The data table contains
**{{rows.length}} rows**, each containing
the following columns:
{{#each columns}}
**{{name}}**
{{/each}}
You can use standard Markdown in here, but you can also access your piped-in data using Handlebars. If you want to know more, check out the [Handlebars Documentation](http://handlebarsjs.com/expressions.html)
You can use standard Markdown in here, but you can also access your piped-in data using Handlebars. If you want to know more, check out the [Handlebars documentation](http://handlebarsjs.com/expressions.html).
#### Enjoy!" | render`,
});

View file

@ -25,7 +25,7 @@ export const markdown = () => ({
},
font: {
types: ['style'],
help: 'Font settings. Technically you can stick other styles in here too!',
help: 'Font settings. Technically, you can add other styles in here as well',
default: '{font}',
},
},

View file

@ -21,12 +21,12 @@ export const alterColumn = () => ({
},
type: {
types: ['string'],
help: 'The type to convert the column to. Leave blank to not change type.',
help: 'The type to convert the column to. Leave blank to not change type',
default: null,
},
name: {
types: ['string'],
help: 'The resultant column name. Leave blank to not rename.',
help: 'The resultant column name. Leave blank to not rename',
default: null,
},
},

View file

@ -21,7 +21,7 @@ export const axisConfig = () => ({
},
position: {
types: ['string'],
help: 'Position of the axis labels. Eg, top, bottom, left, and right.',
help: 'Position of the axis labels - top, bottom, left, and right',
default: '',
},
min: {

View file

@ -7,7 +7,7 @@
export const caseFn = () => ({
name: 'case',
type: 'case',
help: 'Build a case (including a condition/result) to pass to the switch function.',
help: 'Build a case (including a condition/result) to pass to the switch function',
args: {
when: {
aliases: ['_'],

View file

@ -20,19 +20,19 @@ export const date = () => ({
context: {
types: ['null'],
},
help: 'Returns the current time, or a time parsed from a string, as milliseconds since epoch.',
help: 'Returns the current time, or a time parsed from a string, as milliseconds since epoch',
args: {
value: {
aliases: ['_'],
types: ['string', 'null'],
help:
'An optional date string to parse into milliseconds since epoch. ' +
'Can be either a valid Javascript Date input or a string to parse using the format argument. Must be an ISO 8601 string or you must provide the format.',
'An optional date string to parse into milliseconds since epoch ' +
'Can be either a valid Javascript Date input or a string to parse using the format argument. Must be an ISO 8601 string or you must provide the format',
},
format: {
types: ['string'],
help:
'The momentJS format for parsing the optional date string (See https://momentjs.com/docs/#/displaying/).',
'The momentJS format for parsing the optional date string (See https://momentjs.com/docs/#/displaying/)',
},
},
fn: (context, args) => {

View file

@ -17,9 +17,9 @@ export const seriesStyle = () => ({
args: {
label: {
types: ['string'],
displayName: 'Series Label',
displayName: 'Series label',
help:
'The label of the line this style applies to, not the name you would like to give the line.',
'The label of the line this style applies to, not the name you would like to give the line',
},
color: {
types: ['string', 'null'],
@ -33,12 +33,12 @@ export const seriesStyle = () => ({
},
bars: {
types: ['number'],
displayName: 'Bar Width',
displayName: 'Bar width',
help: 'Width of bars',
},
points: {
types: ['number'],
displayName: 'Show Points',
displayName: 'Show points',
help: 'Size of points on line',
},
fill: {
@ -48,13 +48,13 @@ export const seriesStyle = () => ({
},
stack: {
types: ['number', 'null'],
displayName: 'Stack Series',
displayName: 'Stack series',
help:
'Should we stack the series? This is the stack "id". Series with the same stack id will be stacked together',
},
horizontalBars: {
types: ['boolean'],
displayName: 'Horizontal Bars Orientation',
displayName: 'Horizontal bars orientation',
help: 'Sets the orientation of bars in the chart to horizontal',
},
},

View file

@ -9,7 +9,7 @@ import { getType } from '../../../common/lib/get_type';
export const staticColumn = () => ({
name: 'staticColumn',
type: 'datatable',
help: 'Add a column with a static value.',
help: 'Add a column with a static value',
context: {
types: ['datatable'],
},

View file

@ -21,7 +21,7 @@ export const table = () => ({
paginate: {
types: ['boolean'],
default: true,
help: 'Show pagination controls. If set to false only the first page will be displayed.',
help: 'Show pagination controls. If set to false only the first page will be displayed',
},
perPage: {
types: ['number'],
@ -31,7 +31,7 @@ export const table = () => ({
showHeader: {
types: ['boolean'],
default: true,
help: 'Show or hide the header row with titles for each column.',
help: 'Show or hide the header row with titles for each column',
},
},
fn: (context, args) => {

View file

@ -12,7 +12,7 @@ export const demodata = () => ({
name: 'demodata',
aliases: [],
type: 'datatable',
help: 'A mock data set that includes project CI times with usernames, countries and run phases.',
help: 'A mock data set that includes project CI times with usernames, countries and run phases',
context: {
types: ['filter'],
},

View file

@ -36,7 +36,7 @@ export const esdocs = () => ({
help: 'Sort directions as "field, direction". Eg "@timestamp, desc" or "bytes, asc"',
},
fields: {
help: 'Comma separated list of fields. Fewer fields will perform better.',
help: 'Comma separated list of fields. Fewer fields will perform better',
types: ['string', 'null'],
},
metaFields: {

View file

@ -42,7 +42,7 @@ export const timelion = () => ({
},
},
type: 'datatable',
help: 'Use timelion to extract one or more timeseries from many sources.',
help: 'Use timelion to extract one or more timeseries from many sources',
fn: (context, args, handlers) => {
// Timelion requires a time range. Use the time range from the timefilter element in the
// workpad, if it exists. Otherwise fall back on the function args.

View file

@ -10,7 +10,7 @@ import { AdvancedFilter } from './component';
export const advancedFilter = () => ({
name: 'advanced_filter',
displayName: 'Advanced Filter',
displayName: 'Advanced filter',
help: 'Render a Canvas filter expression',
reuseDomNode: true,
height: 50,

View file

@ -12,7 +12,7 @@ import { DropdownFilter } from './component';
export const dropdownFilter = () => ({
name: 'dropdown_filter',
displayName: 'Dropdown Filter',
displayName: 'Dropdown filter',
help: 'A dropdown from which you can select values for an "exactly" filter',
reuseDomNode: true,
height: 50,

View file

@ -12,7 +12,7 @@ import { Popover } from '../../../public/components/popover';
export const error = () => ({
name: 'error',
displayName: 'Error Information',
displayName: 'Error information',
help: 'Render error data in a way that is helpful to users',
reuseDomNode: true,
render(domNode, config, handlers) {

View file

@ -11,7 +11,7 @@ import { isValid } from '../../common/lib/url';
export const repeatImage = () => ({
name: 'repeatImage',
displayName: 'Image Repeat',
displayName: 'Image repeat',
help: 'Repeat an image a given number of times',
reuseDomNode: true,
render(domNode, config, handlers) {

View file

@ -10,7 +10,7 @@ import './reveal_image.scss';
export const revealImage = () => ({
name: 'revealImage',
displayName: 'Image Reveal',
displayName: 'Image reveal',
help: 'Reveal a percentage of an image to make a custom gauge-style chart',
reuseDomNode: true,
render(domNode, config, handlers) {

View file

@ -11,7 +11,7 @@ import { Datatable } from '../../public/components/datatable';
export const table = () => ({
name: 'table',
displayName: 'Data Table',
displayName: 'Data table',
help: 'Render tabular data as HTML',
reuseDomNode: true,
render(domNode, config, handlers) {

View file

@ -9,7 +9,7 @@ import React from 'react';
export const text = () => ({
name: 'text',
displayName: 'Plain Text',
displayName: 'Plain text',
help: 'Render output as plain text',
reuseDomNode: true,
render(domNode, { text }, handlers) {

View file

@ -12,7 +12,7 @@ import { TimeFilter } from './components/time_filter';
export const timeFilter = () => ({
name: 'time_filter',
displayName: 'Time Filter',
displayName: 'Time filter',
help: 'Set a time window',
reuseDomNode: true,
render(domNode, config, handlers) {

View file

@ -10,7 +10,7 @@ import { ExtendedTemplate } from './extended_template';
export const axisConfig = () => ({
name: 'axisConfig',
displayName: 'Axis Config',
displayName: 'Axis config',
help: 'Visualization axis configuration',
simpleTemplate: templateFromReactComponent(SimpleTemplate),
template: templateFromReactComponent(ExtendedTemplate),

View file

@ -168,7 +168,7 @@ class ImageUpload extends React.Component {
export const imageUpload = () => ({
name: 'imageUpload',
displayName: 'Image Upload',
displayName: 'Image upload',
help: 'Select or upload an image',
resolveArgValue: true,
template: templateFromReactComponent(ImageUpload),

View file

@ -65,7 +65,7 @@ PaletteArgInput.propTypes = {
export const palette = () => ({
name: 'palette',
displayName: 'Color Palette',
displayName: 'Color palette',
help: 'Choose a color palette',
default:
'{palette #882E72 #B178A6 #D6C1DE #1965B0 #5289C7 #7BAFDE #4EB265 #90C987 #CAE0AB #F7EE55 #F6C141 #F1932D #E8601C #DC050C}',

View file

@ -57,7 +57,7 @@ EnhancedStringArgInput.propTypes = {
export const string = () => ({
name: 'string',
displayName: 'string',
displayName: 'String',
help: 'Input short strings',
simpleTemplate: templateFromReactComponent(EnhancedStringArgInput),
});

View file

@ -63,7 +63,7 @@ EnhancedTextAreaArgInput.propTypes = {
export const textarea = () => ({
name: 'textarea',
displayName: 'textarea',
displayName: 'Textarea',
help: 'Input long strings',
template: templateFromReactComponent(EnhancedTextAreaArgInput),
});

View file

@ -14,16 +14,16 @@ const DemodataDatasource = () => (
<p>
This data source is connected to every Canvas element by default. Its purpose is to give you
some playground data to get started. The demo set contains 4 strings, 3 numbers and a date.
Feel free to experiment and, when you're ready, click the <strong>Change Datasource</strong>{' '}
link below to connect to your own data.
Feel free to experiment and, when you're ready, click <strong>Change your data source</strong>{' '}
above to connect to your own data.
</p>
</EuiText>
);
export const demodata = () => ({
name: 'demodata',
displayName: 'Demo Data',
help: 'Mock data set with with usernames, prices, projects, countries and phases.',
displayName: 'Demo data',
help: 'Mock data set with usernames, prices, projects, countries, and phases',
// Replace this with a better icon when we have time.
image: 'logoElasticStack',
template: templateFromReactComponent(DemodataDatasource),

View file

@ -71,7 +71,7 @@ EssqlDatasource.propTypes = {
export const essql = () => ({
name: 'essql',
displayName: 'Elasticsearch SQL',
help: 'Use Elasticsearch SQL to get a datatable',
help: 'Use Elasticsearch SQL to get a data table',
// Replace this with a SQL logo when we have one in EUI
image: 'logoElasticsearch',
template: templateFromReactComponent(EssqlDatasource),

View file

@ -99,7 +99,7 @@ TimelionDatasource.propTypes = {
export const timelion = () => ({
name: 'timelion',
displayName: 'Timelion',
help: 'Use timelion syntax to retrieve a timeseries',
help: 'Use Timelion syntax to retrieve a timeseries',
image: 'timelionApp',
template: templateFromReactComponent(TimelionDatasource),
});

View file

@ -9,7 +9,7 @@ import { getState, getValue } from '../../../public/lib/resolved_arg';
export const pointseries = () => ({
name: 'pointseries',
displayName: 'Dimensions & Measures',
displayName: 'Dimensions & measures',
args: [
{
name: 'x',
@ -20,7 +20,7 @@ export const pointseries = () => ({
{
name: 'y',
displayName: 'Y-axis',
help: 'Data along the vertical axis. Usually a number.',
help: 'Data along the vertical axis. Usually a number',
argType: 'datacolumn',
},
{

View file

@ -9,11 +9,11 @@ import { getState, getValue } from '../../../public/lib/resolved_arg';
export const sort = () => ({
name: 'sort',
displayName: 'Datatable Sorting',
displayName: 'Datatable sorting',
args: [
{
name: '_',
displayName: 'Sort Field',
displayName: 'Sort field',
argType: 'datacolumn',
},
{

View file

@ -9,12 +9,12 @@ import { getState, getValue } from '../../../public/lib/resolved_arg';
export const dropdownControl = () => ({
name: 'dropdownControl',
displayName: 'Dropdown Filter',
displayName: 'Dropdown filter',
modelArgs: [],
args: [
{
name: 'valueColumn',
displayName: 'Values Column',
displayName: 'Values column',
help: 'Column from which to extract values to make available in the dropdown',
argType: 'string',
options: {
@ -23,7 +23,7 @@ export const dropdownControl = () => ({
},
{
name: 'filterColumn',
displayName: 'Filter Column ',
displayName: 'Filter column ',
help: 'Column to which the value selected from the dropdown is applied',
argType: 'string',
options: {

View file

@ -6,7 +6,7 @@
export const getCell = () => ({
name: 'getCell',
displayName: 'Get Cell',
displayName: 'Get cell',
help: 'Grab the first row and first column',
modelArgs: ['size'],
requiresContext: true,

View file

@ -21,14 +21,14 @@ export const metric = () => ({
},
{
name: 'metricFont',
displayName: 'Metric Text Settings',
displayName: 'Metric text settings',
help: 'Fonts, alignment and color',
argType: 'font',
default: `{font size=48 family="${openSans.value}" color="#000000" align=center lHeight=48}`,
},
{
name: 'labelFont',
displayName: 'Label Text Settings',
displayName: 'Label text settings',
help: 'Fonts, alignment and color',
argType: 'font',
default: `{font size=18 family="${openSans.value}" color="#000000" align=center}`,

View file

@ -10,7 +10,7 @@ import { getState, getValue } from '../../../public/lib/resolved_arg';
export const pie = () => ({
name: 'pie',
displayName: 'Chart Style',
displayName: 'Chart style',
modelArgs: [['color', { label: 'Slice Labels' }], ['size', { label: 'Slice Angles' }]],
args: [
{
@ -19,7 +19,7 @@ export const pie = () => ({
},
{
name: 'hole',
displayName: 'Inner Radius',
displayName: 'Inner radius',
help: 'Radius of the hole',
argType: 'range',
default: 50,
@ -37,7 +37,7 @@ export const pie = () => ({
},
{
name: 'labelRadius',
displayName: 'Label Radius',
displayName: 'Label radius',
help: 'Distance of the labels from the center of the pie',
argType: 'range',
default: 100,
@ -48,7 +48,7 @@ export const pie = () => ({
},
{
name: 'legend',
displayName: 'Legend Position',
displayName: 'Legend position',
help: 'Disable or position the legend',
argType: 'select',
default: 'ne',
@ -74,7 +74,7 @@ export const pie = () => ({
},
{
name: 'tilt',
displayName: 'Tilt Angle',
displayName: 'Tilt angle',
help: 'Percentage of tilt where 1 is fully vertical and 0 is completely flat',
argType: 'percentage',
default: 1,

View file

@ -12,7 +12,7 @@ const styleProps = ['lines', 'bars', 'points', 'fill', 'stack'];
export const plot = () => ({
name: 'plot',
displayName: 'Chart Style',
displayName: 'Chart style',
modelArgs: ['x', 'y', 'color', 'size', 'text'],
args: [
{
@ -21,7 +21,7 @@ export const plot = () => ({
},
{
name: 'legend',
displayName: 'Legend Position',
displayName: 'Legend position',
help: 'Disable or position the legend',
argType: 'select',
default: 'ne',
@ -31,14 +31,14 @@ export const plot = () => ({
},
{
name: 'xaxis',
displayName: 'X-Axis',
displayName: 'X-axis',
help: 'Configure or disable the x-axis',
argType: 'axisConfig',
default: true,
},
{
name: 'yaxis',
displayName: 'Y-Axis',
displayName: 'Y-axis',
help: 'Configure or disable the Y-axis',
argType: 'axisConfig',
default: true,
@ -50,7 +50,7 @@ export const plot = () => ({
{
name: 'defaultStyle',
displayName: 'Default style',
help: 'Set the style to be used by default by every series, unless overridden.',
help: 'Set the style to be used by default by every series, unless overridden',
argType: 'seriesStyle',
default: '{seriesStyle points=5}',
options: {

View file

@ -33,28 +33,28 @@ export const progress = () => ({
},
{
name: 'valueColor',
displayName: 'Progress Color',
displayName: 'Progress color',
help: 'Color of the progress bar',
argType: 'color',
default: `#1785b0`,
},
{
name: 'valueWeight',
displayName: 'Progress Weight',
displayName: 'Progress weight',
help: 'Thickness of the progress bar',
argType: 'number',
default: '20',
},
{
name: 'barColor',
displayName: 'Background Color',
displayName: 'Background color',
help: 'Color of the background bar',
argType: 'color',
default: `#f0f0f0`,
},
{
name: 'barWeight',
displayName: 'Background Weight',
displayName: 'Background weight',
help: 'Thickness of the background bar',
argType: 'number',
default: '20',
@ -68,8 +68,8 @@ export const progress = () => ({
},
{
name: 'font',
displayName: 'Label Settings',
help: 'Font settings for the label. Technically you can stick other styles in here too!',
displayName: 'Label settings',
help: 'Font settings for the label. Technically, you can add other styles as well',
argType: 'font',
default: `{font size=24 family="${openSans.value}" color="#000000" align=center}`,
},

View file

@ -6,7 +6,7 @@
export const repeatImage = () => ({
name: 'repeatImage',
displayName: 'Repeating Image',
displayName: 'Repeating image',
help: '',
modelArgs: [['_', { label: 'Value' }]],
args: [
@ -18,7 +18,7 @@ export const repeatImage = () => ({
},
{
name: 'emptyImage',
displayName: 'Empty Image',
displayName: 'Empty image',
help: 'An image to fill up the difference between the value and the max count',
argType: 'imageUpload',
},

View file

@ -6,7 +6,7 @@
export const revealImage = () => ({
name: 'revealImage',
displayName: 'Reveal Image',
displayName: 'Reveal image',
help: '',
modelArgs: [['_', { label: 'Value' }]],
args: [
@ -18,7 +18,7 @@ export const revealImage = () => ({
},
{
name: 'emptyImage',
displayName: 'Background Image',
displayName: 'Background image',
help: 'A background image. Eg, an empty glass',
argType: 'imageUpload',
},

View file

@ -14,7 +14,7 @@ export const shape = () => ({
args: [
{
name: '_',
displayName: 'Select a Shape',
displayName: 'Select a shape',
argType: 'shape',
options: {
shapes,
@ -34,13 +34,13 @@ export const shape = () => ({
},
{
name: 'borderWidth',
displayName: 'Border Width',
displayName: 'Border width',
argType: 'number',
help: 'Border width',
},
{
name: 'maintainAspect',
displayName: 'Maintain Aspect Ratio',
displayName: 'Maintain aspect ratio',
argType: 'toggle',
help: `Select 'true' to maintain aspect ratio`,
},

View file

@ -6,7 +6,7 @@
export const table = () => ({
name: 'table',
displayName: 'Table Style',
displayName: 'Table style',
help: 'Set styling for a Table element',
modelArgs: [],
args: [
@ -17,7 +17,7 @@ export const table = () => ({
{
name: 'perPage',
displayName: 'Rows per page',
help: 'Number of rows to display per table page.',
help: 'Number of rows to display per table page',
argType: 'select',
default: 10,
options: {
@ -27,14 +27,14 @@ export const table = () => ({
{
name: 'paginate',
displayName: 'Pagination',
help: 'Show or hide pagination controls. If disabled only the first page will be shown.',
help: 'Show or hide pagination controls. If disabled only the first page will be shown',
argType: 'toggle',
default: true,
},
{
name: 'showHeader',
displayName: 'Header',
help: 'Show or hide the header row with titles for each column.',
help: 'Show or hide the header row with titles for each column',
argType: 'toggle',
default: true,
},

View file

@ -9,7 +9,7 @@ import { getState, getValue } from '../../../public/lib/resolved_arg';
export const timefilterControl = () => ({
name: 'timefilterControl',
displayName: 'Time Filter',
displayName: 'Time filter',
modelArgs: [],
args: [
{

View file

@ -9,7 +9,7 @@ import { castProvider } from '../interpreter/cast';
export const to = () => ({
name: 'to',
aliases: [],
help: 'Explicitly cast from one type to another.',
help: 'Explicitly cast from one type to another',
context: {},
args: {
type: {

View file

@ -26,7 +26,7 @@ const wrap = Component =>
export const containerStyle = () => ({
name: 'containerStyle',
displayName: 'Container Style',
displayName: 'Container style',
help: 'Tweak the appearance of the element container',
default: '{containerStyle}',
simpleTemplate: templateFromReactComponent(wrap(SimpleTemplate)),

View file

@ -53,7 +53,7 @@ FontArgInput.displayName = 'FontArgInput';
export const font = () => ({
name: 'font',
displayName: 'Text Settings',
displayName: 'Text settings',
help: 'Set the font, size and color',
template: templateFromReactComponent(FontArgInput),
default: `{font size=14 family="${openSans.value}" color="#000000" align=left}`,

View file

@ -35,7 +35,7 @@ EnhancedExtendedTemplate.propTypes = {
export const seriesStyle = () => ({
name: 'seriesStyle',
displayName: 'Series Style',
displayName: 'Series style',
help: 'Set the style for a selected named series',
template: templateFromReactComponent(EnhancedExtendedTemplate),
simpleTemplate: templateFromReactComponent(SimpleTemplate),

View file

@ -115,7 +115,7 @@ EsdocsDatasource.propTypes = {
export const esdocs = () => ({
name: 'esdocs',
displayName: 'Elasticsearch Raw Documents',
displayName: 'Elasticsearch raw documents',
help: 'Pull back raw documents from elasticsearch',
image: 'logoElasticsearch',
template: templateFromReactComponent(EsdocsDatasource),

View file

@ -14,7 +14,7 @@ export const asset = () => ({
types: ['null'],
},
type: 'string',
help: 'Use Canvas workpad asset objects to provide argument values. Usually images.',
help: 'Use Canvas workpad asset objects to provide argument values. Usually images',
args: {
id: {
aliases: ['_'],