[Canvas] Update filters description/docs with deprecation warning (#154557)

## Summary

Related to #113530.
Related to #141526.

This updates the help text for the `filters` indicating that it is
deprecated with a suggestion to use `kibana | selectFilters` instead.

<img width="526" alt="Screenshot 2023-04-10 at 8 18 41 AM"
src="https://user-images.githubusercontent.com/1697105/230931182-ba17068f-82ba-4e3e-b687-14b0e9211d5b.png">


### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
This commit is contained in:
Catherine Liu 2023-04-10 15:12:28 -07:00 committed by GitHub
parent 6c9ea67487
commit acb12665d2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 6 additions and 4 deletions

View file

@ -35,6 +35,7 @@ export function buildFiltersFunction(
context: {
types: ['null'],
},
deprecated: true,
args: {
group: {
aliases: ['_'],

View file

@ -13,7 +13,11 @@ import { FunctionFactory } from '../../../types';
export const help: FunctionHelp<FunctionFactory<ReturnType<typeof filtersFunctionFactory>>> = {
help: i18n.translate('xpack.canvas.functions.filtersHelpText', {
defaultMessage:
'Aggregates element filters from the workpad for use elsewhere, usually a data source.',
'Aggregates element filters from the workpad for use elsewhere, usually a data source. {FILTER_FN} is deprecated and will be removed in a future release. Use {REPLACEMENT} instead.',
values: {
FILTER_FN: '`filters`',
REPLACEMENT: '`kibana | selectFilter`',
},
}),
args: {
group: i18n.translate('xpack.canvas.functions.filters.args.group', {

View file

@ -9072,7 +9072,6 @@
"xpack.canvas.functions.exactlyHelpText": "Crée un filtre qui fait correspondre une colonne donnée à une valeur exacte.",
"xpack.canvas.functions.filters.args.group": "Nom du groupe de filtres à utiliser.",
"xpack.canvas.functions.filters.args.ungrouped": "Exclure les filtres qui appartiennent à un groupe de filtres ?",
"xpack.canvas.functions.filtersHelpText": "Agrège les filtres d'éléments du workpad qui doivent être utilisés ailleurs, généralement, une source de données.",
"xpack.canvas.functions.getCell.args.columnHelpText": "Nom de la colonne dans laquelle récupérer la valeur. S'il n'est pas renseigné, la valeur est récupérée dans la première colonne.",
"xpack.canvas.functions.getCell.args.rowHelpText": "Numéro de ligne, démarrant à 0.",
"xpack.canvas.functions.getCell.columnNotFoundErrorMessage": "Colonne introuvable : \"{column}\"",

View file

@ -9072,7 +9072,6 @@
"xpack.canvas.functions.exactlyHelpText": "特定の列をピッタリと正確な値に一致させるフィルターを作成します。",
"xpack.canvas.functions.filters.args.group": "使用するフィルターグループの名前です。",
"xpack.canvas.functions.filters.args.ungrouped": "フィルターグループに属するフィルターを除外しますか?",
"xpack.canvas.functions.filtersHelpText": "ワークパッドのエレメントフィルターを他(通常データソース)で使用できるように集約します。",
"xpack.canvas.functions.getCell.args.columnHelpText": "値を取得する元の列の名前です。この値は入力されていないと、初めの列から取得されます。",
"xpack.canvas.functions.getCell.args.rowHelpText": "行番号で、0 から開始します。",
"xpack.canvas.functions.getCell.columnNotFoundErrorMessage": "列が見つかりません。'{column}'",

View file

@ -9072,7 +9072,6 @@
"xpack.canvas.functions.exactlyHelpText": "创建使给定列匹配确切值的筛选。",
"xpack.canvas.functions.filters.args.group": "要使用的筛选组的名称。",
"xpack.canvas.functions.filters.args.ungrouped": "排除属于筛选组的筛选?",
"xpack.canvas.functions.filtersHelpText": "聚合 Workpad 的元素筛选以用于他处,通常用于数据源。",
"xpack.canvas.functions.getCell.args.columnHelpText": "从其中提取值的列的名称。如果未提供,将从第一列检索值。",
"xpack.canvas.functions.getCell.args.rowHelpText": "行编号,从 0 开始。",
"xpack.canvas.functions.getCell.columnNotFoundErrorMessage": "找不到列:“{column}”",