Skip to content

Commit

Permalink
Rephrase and add changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
huong-li-nguyen committed Oct 25, 2023
1 parent 95749ae commit e4f3e2d
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 11 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

<!--
### Removed
- A bullet item for the Removed category.
-->
<!--
### Added
- A bullet item for the Added category.
-->
<!--
### Changed
- A bullet item for the Changed category.
-->
<!--
### Deprecated
- A bullet item for the Deprecated category.
-->
<!--
### Fixed
- A bullet item for the Fixed category.
-->
<!--
### Security
- A bullet item for the Security category.
-->
5 changes: 3 additions & 2 deletions vizro-core/docs/pages/user_guides/custom_charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 3 additions & 7 deletions vizro-core/docs/pages/user_guides/custom_components.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
5 changes: 3 additions & 2 deletions vizro-core/docs/pages/user_guides/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit e4f3e2d

Please sign in to comment.