From e4f3e2d160d25ed5bb9056f8c2cb807de9377b7f Mon Sep 17 00:00:00 2001 From: huong-li-nguyen Date: Wed, 25 Oct 2023 12:57:38 +0200 Subject: [PATCH] Rephrase and add changelog --- ...guyen_add_disclaimer_for_custom_created.md | 42 +++++++++++++++++++ .../docs/pages/user_guides/custom_charts.md | 5 ++- .../pages/user_guides/custom_components.md | 10 ++--- .../docs/pages/user_guides/integration.md | 5 ++- 4 files changed, 51 insertions(+), 11 deletions(-) create mode 100644 vizro-core/changelog.d/20231025_125539_huong_li_nguyen_add_disclaimer_for_custom_created.md diff --git a/vizro-core/changelog.d/20231025_125539_huong_li_nguyen_add_disclaimer_for_custom_created.md b/vizro-core/changelog.d/20231025_125539_huong_li_nguyen_add_disclaimer_for_custom_created.md new file mode 100644 index 000000000..d57e34cc2 --- /dev/null +++ b/vizro-core/changelog.d/20231025_125539_huong_li_nguyen_add_disclaimer_for_custom_created.md @@ -0,0 +1,42 @@ + + + + + + + + diff --git a/vizro-core/docs/pages/user_guides/custom_charts.md b/vizro-core/docs/pages/user_guides/custom_charts.md index 70dc377a0..4e8bca2f7 100644 --- a/vizro-core/docs/pages/user_guides/custom_charts.md +++ b/vizro-core/docs/pages/user_guides/custom_charts.md @@ -157,5 +157,6 @@ The below examples shows a more involved use-case. We create and style a waterfa ???+ warning - Please note that Vizro is not responsible for any custom-created component or integration. - Ensure that your custom-created components or integrations do not leak any sensitive information or expose users to any security threat. + Please note that Vizro is not responsible for any custom-created component or integration. + Ensure that your custom-created components or integrations do not leak any sensitive information or expose users + to any security threat before deploying your dashboards. diff --git a/vizro-core/docs/pages/user_guides/custom_components.md b/vizro-core/docs/pages/user_guides/custom_components.md index 4fc71d30d..38b31f09d 100644 --- a/vizro-core/docs/pages/user_guides/custom_components.md +++ b/vizro-core/docs/pages/user_guides/custom_components.md @@ -7,11 +7,6 @@ In general, you can create a custom component based on any dash-compatible compo [dash-bootstrap-components](https://dash-bootstrap-components.opensource.faculty.ai/), [dash-html-components](https://github.com/plotly/dash/tree/dev/components/dash-html-components), etc.). -!!!warning - When creating your own custom components, you are responsible for the security of your component (e.g. prevent setting HTML from code which might expose users to cross-site scripting). Vizro cannot guarantee - the security of custom created components, so make sure you keep this in mind when publicly deploying your dashboard. - - Vizro's public API is deliberately kept small in order to facilitate quick and easy configuration of a dashboard. However, at the same time, Vizro is easily extensible, so that you can tweak any component to your liking or even create entirely new ones. @@ -359,5 +354,6 @@ vm.Page.add_type("components", Jumbotron) ???+ warning - Please note that Vizro is not responsible for any custom-created component or integration. - Ensure that your custom-created components or integrations do not leak any sensitive information or expose users to any security threat. + Please note that Vizro is not responsible for any custom-created component or integration. + Ensure that your custom-created components or integrations do not leak any sensitive information or expose users + to any security threat before deploying your dashboards. diff --git a/vizro-core/docs/pages/user_guides/integration.md b/vizro-core/docs/pages/user_guides/integration.md index 399a1024d..180daa9c1 100644 --- a/vizro-core/docs/pages/user_guides/integration.md +++ b/vizro-core/docs/pages/user_guides/integration.md @@ -50,5 +50,6 @@ register the datasets with [`kedro_datasets.pandas`](https://docs.kedro.org/en/s ???+ warning - Please note that Vizro is not responsible for any custom-created component or integration. - Ensure that your custom-created components or integrations do not leak any sensitive information or expose users to any security threat. + Please note that Vizro is not responsible for any custom-created component or integration. + Ensure that your custom-created components or integrations do not leak any sensitive information or expose users + to any security threat before deploying your dashboards.