kibana/docs/setup
Tim Sullivan 2ff5410161
[Reporting/CSV] Deprecate Download CSV, add a config flag to enable (#178159)
Closes https://github.com/elastic/kibana/issues/164104

## Summary

**Replace "Download CSV" with "Generate CSV report" to export a CSV file
from saved search panel, deprecate "Download CSV", use a config flag for
providing the deprecated feature.**

This PR uses the `xpack.reporting.csv.enablePanelActionDownload`
kibana.yml setting, which was previously unused, for choosing behavior
of CSV export in a Dashboard saved search panel, and sets the default
value to `false`. The options allow the user to download a CSV file
without creating a report (deprecated, support will be removed in the
future) or to generate a CSV report (default).

1. Use the config as a flag to switch between implementations:
    - downloading a CSV file without a generated report
    - generating a CSV report
2. Updated documentation
3. Refactored / cleaned up tests
4. Increased API test coverage in Serverless
5. Better error handling in
`packages/kbn-reporting/public/reporting_api_client.ts`

### Checklist

Delete any items that are not applicable to this PR.

- [x] 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)
- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [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
- [x] 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)

## Release Note
Kibana CSV Reporting offered a feature allowing users to download a CSV
file from a saved search panel in a dashboard, without having a report
generated. This feature is now deprecated. Now, when users need to
access saved search data from a dashboard panel as CSV, a normal report
will be generated. To access the deprecated functionality, you can add
`xpack.reporting.csv.enablePanelActionDownload: true` to kibana.yml, but
this ability will be removed in a future version of Kibana.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2024-03-22 18:28:09 -07:00
..
images [DOCS] Updates Canvas with new toolbar (#123418) 2022-01-26 10:40:36 -06:00
install [DOCS] Add link to on-prem install tutorial (#176096) 2024-02-05 10:22:15 -05:00
upgrade Update saved objects migrations documentation for 8.8.0 (#158241) 2023-05-23 15:53:52 +02:00
access.asciidoc (DOC+) Link Kibana Health Troubleshooting blog to related doc (#177907) 2024-03-05 11:15:27 -07:00
configuring-logging.asciidoc [docs-logging]: move developer/architecture docs to user docs (#119125) 2021-11-24 16:42:28 -05:00
configuring-reporting.asciidoc [Reporting/CSV] Deprecate Download CSV, add a config flag to enable (#178159) 2024-03-22 18:28:09 -07:00
connect-to-elasticsearch.asciidoc [Cloud] Rename "Endpoints" to "Connection details" (#171982) 2023-11-27 15:58:42 +00:00
docker.asciidoc Revert "[build/docker] Upgrade Ubuntu base image to 22.04 (#162282)" (#170430) 2023-11-02 12:56:17 -05:00
install.asciidoc [Docs] remove Kibana book-scoped variables (#178676) 2024-03-14 11:53:33 -04:00
secure-settings.asciidoc Improve keystore CLI (#157359) 2023-05-16 16:21:25 +02:00
settings.asciidoc [Docs] remove Kibana book-scoped variables (#178676) 2024-03-14 11:53:33 -04:00
start-stop.asciidoc [DOCS] Removes Homebrew docs (#125155) 2022-02-09 13:30:49 -08:00
upgrade.asciidoc Adds documentation and improves migrations failing on timeouts while waiting for index yellow status (#130352) 2022-04-21 08:11:39 -07:00