From b94cf20d4dab61a77e5f022be79e7aa6ef5bcf80 Mon Sep 17 00:00:00 2001 From: Maximilian Schulz Date: Thu, 28 Sep 2023 10:01:02 +0200 Subject: [PATCH 01/10] Add why Vizro section to README --- README.md | 12 ++++++++++++ vizro-core/README.md | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/README.md b/README.md index d5a1c4ae4..0ad2bdcfe 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,18 @@ Optional high-code extensions allow almost infinite customisation in a modular w
+### Why Vizro + +In the context of comparison with other visualization packages or business intelligence tools, Vizro combines benefits of the speed and user-friendliness of low-code visual analytics tools with the flexibility and power of high-code tools, whilst providing inbuilt visual design, application architecture and coding standardization + +The simple and largely declarative configuration language follows a “grammar of dashboards” which makes the creation of complex dashboards more intuitive. This leverages modular components, empowering users to rapidly self-serve the assembly of customized dashboards with inbuilt visual styling in minutes, and reduces the amount of “glue code” required, whilst still retaining the ability to enhance functionality almost infinitely through customization and extensions, with standardization increasing the consistency across outputs. + +Using configuration rather than a GUI to define the output facilitates collaboration during the creation process, and increases reusability and scalability in a Python setting. + +The largely tech-agnostic configuration driven assembly enables utilizing a range of tools, and an inbuilt validation layer provides meaningful feedback to users about configuration choices, thereby increasing flexibility and ease of use. + +
+ ### Key benefits
diff --git a/vizro-core/README.md b/vizro-core/README.md index d5a1c4ae4..0ad2bdcfe 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -78,6 +78,18 @@ Optional high-code extensions allow almost infinite customisation in a modular w
+### Why Vizro + +In the context of comparison with other visualization packages or business intelligence tools, Vizro combines benefits of the speed and user-friendliness of low-code visual analytics tools with the flexibility and power of high-code tools, whilst providing inbuilt visual design, application architecture and coding standardization + +The simple and largely declarative configuration language follows a “grammar of dashboards” which makes the creation of complex dashboards more intuitive. This leverages modular components, empowering users to rapidly self-serve the assembly of customized dashboards with inbuilt visual styling in minutes, and reduces the amount of “glue code” required, whilst still retaining the ability to enhance functionality almost infinitely through customization and extensions, with standardization increasing the consistency across outputs. + +Using configuration rather than a GUI to define the output facilitates collaboration during the creation process, and increases reusability and scalability in a Python setting. + +The largely tech-agnostic configuration driven assembly enables utilizing a range of tools, and an inbuilt validation layer provides meaningful feedback to users about configuration choices, thereby increasing flexibility and ease of use. + +
+ ### Key benefits
From 4ae77289c6b272070e6813eb48d1f8b57a312329 Mon Sep 17 00:00:00 2001 From: Maximilian Schulz Date: Thu, 28 Sep 2023 10:02:39 +0200 Subject: [PATCH 02/10] American spelling --- README.md | 8 ++++---- vizro-core/README.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0ad2bdcfe..f3eafae84 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ Vizro is a toolkit for creating modular data visualization applications

-Rapidly self-serve the assembly of customised dashboards in minutes - without the need for advanced coding or design experience - to create flexible and scalable, Python enabled data visualization applications +Rapidly self-serve the assembly of customized dashboards in minutes - without the need for advanced coding or design experience - to create flexible and scalable, Python enabled data visualization applications

@@ -69,12 +69,12 @@ Define high level categories within the configuration, including: - **components:** create charts, tables, input/output interfaces, and more - **controls**: create filters, parameter inputs, and custom action controllers -- **pages, layouts and navigation**: create multiple pages, with customisable layouts and flexible navigation across them -- **actions and interactions**: create interactions between charts, and use pre-defined or customised actions (such as exporting) +- **pages, layouts and navigation**: create multiple pages, with customizable layouts and flexible navigation across them +- **actions and interactions**: create interactions between charts, and use pre-defined or customized actions (such as exporting) Configuration can be written in multiple formats including **Pydantic models**, **JSON**, **YAML** or **Python dictionaries** for added flexibility of implementation -Optional high-code extensions allow almost infinite customisation in a modular way, combining the best of low-code and high-code - for flexible and scalable, Python enabled data visualization applications +Optional high-code extensions allow almost infinite customization in a modular way, combining the best of low-code and high-code - for flexible and scalable, Python enabled data visualization applications
diff --git a/vizro-core/README.md b/vizro-core/README.md index 0ad2bdcfe..f3eafae84 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -55,7 +55,7 @@ Vizro is a toolkit for creating modular data visualization applications

-Rapidly self-serve the assembly of customised dashboards in minutes - without the need for advanced coding or design experience - to create flexible and scalable, Python enabled data visualization applications +Rapidly self-serve the assembly of customized dashboards in minutes - without the need for advanced coding or design experience - to create flexible and scalable, Python enabled data visualization applications

@@ -69,12 +69,12 @@ Define high level categories within the configuration, including: - **components:** create charts, tables, input/output interfaces, and more - **controls**: create filters, parameter inputs, and custom action controllers -- **pages, layouts and navigation**: create multiple pages, with customisable layouts and flexible navigation across them -- **actions and interactions**: create interactions between charts, and use pre-defined or customised actions (such as exporting) +- **pages, layouts and navigation**: create multiple pages, with customizable layouts and flexible navigation across them +- **actions and interactions**: create interactions between charts, and use pre-defined or customized actions (such as exporting) Configuration can be written in multiple formats including **Pydantic models**, **JSON**, **YAML** or **Python dictionaries** for added flexibility of implementation -Optional high-code extensions allow almost infinite customisation in a modular way, combining the best of low-code and high-code - for flexible and scalable, Python enabled data visualization applications +Optional high-code extensions allow almost infinite customization in a modular way, combining the best of low-code and high-code - for flexible and scalable, Python enabled data visualization applications
From 36061b937807f6886d0e1b7410f1f7839e3ba213 Mon Sep 17 00:00:00 2001 From: Maximilian Schulz Date: Thu, 28 Sep 2023 10:03:31 +0200 Subject: [PATCH 03/10] American spelling --- README.md | 2 +- vizro-core/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f3eafae84..44d4a7793 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Rapidly self-serve the assembly of customized dashboards in minutes - without th

-Use a few lines of simple configuration to create complex dashboards, which are automatically assembled utilising libraries such as [**Plotly**](https://github.com/plotly/plotly.py) and [**Dash**](https://github.com/plotly/dash), with inbuilt coding and design best practices +Use a few lines of simple configuration to create complex dashboards, which are automatically assembled utilizing libraries such as [**Plotly**](https://github.com/plotly/plotly.py) and [**Dash**](https://github.com/plotly/dash), with inbuilt coding and design best practices Define high level categories within the configuration, including: diff --git a/vizro-core/README.md b/vizro-core/README.md index f3eafae84..44d4a7793 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -63,7 +63,7 @@ Rapidly self-serve the assembly of customized dashboards in minutes - without th

-Use a few lines of simple configuration to create complex dashboards, which are automatically assembled utilising libraries such as [**Plotly**](https://github.com/plotly/plotly.py) and [**Dash**](https://github.com/plotly/dash), with inbuilt coding and design best practices +Use a few lines of simple configuration to create complex dashboards, which are automatically assembled utilizing libraries such as [**Plotly**](https://github.com/plotly/plotly.py) and [**Dash**](https://github.com/plotly/dash), with inbuilt coding and design best practices Define high level categories within the configuration, including: From 1250b27d2fde33abd07c2d363166e26c1781d28b Mon Sep 17 00:00:00 2001 From: Maximilian Schulz Date: Thu, 28 Sep 2023 11:36:04 +0200 Subject: [PATCH 04/10] Introduce explanation section --- README.md | 8 +------- vizro-core/README.md | 8 +------- vizro-core/docs/index.md | 11 +++++++++++ vizro-core/docs/pages/discussion/why_vizro.md | 9 +++++++++ vizro-core/mkdocs.yml | 3 ++- 5 files changed, 24 insertions(+), 15 deletions(-) create mode 100644 vizro-core/docs/pages/discussion/why_vizro.md diff --git a/README.md b/README.md index 44d4a7793..59d6d95d8 100644 --- a/README.md +++ b/README.md @@ -80,13 +80,7 @@ Optional high-code extensions allow almost infinite customization in a modular w ### Why Vizro -In the context of comparison with other visualization packages or business intelligence tools, Vizro combines benefits of the speed and user-friendliness of low-code visual analytics tools with the flexibility and power of high-code tools, whilst providing inbuilt visual design, application architecture and coding standardization - -The simple and largely declarative configuration language follows a “grammar of dashboards” which makes the creation of complex dashboards more intuitive. This leverages modular components, empowering users to rapidly self-serve the assembly of customized dashboards with inbuilt visual styling in minutes, and reduces the amount of “glue code” required, whilst still retaining the ability to enhance functionality almost infinitely through customization and extensions, with standardization increasing the consistency across outputs. - -Using configuration rather than a GUI to define the output facilitates collaboration during the creation process, and increases reusability and scalability in a Python setting. - -The largely tech-agnostic configuration driven assembly enables utilizing a range of tools, and an inbuilt validation layer provides meaningful feedback to users about configuration choices, thereby increasing flexibility and ease of use. +For an explanation of why you want to use Vizro, please visit the [`Why Vizro section`](https://vizro.readthedocs.io/en/latest/pages/discussion/why_vizro/) of our docs
diff --git a/vizro-core/README.md b/vizro-core/README.md index 44d4a7793..59d6d95d8 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -80,13 +80,7 @@ Optional high-code extensions allow almost infinite customization in a modular w ### Why Vizro -In the context of comparison with other visualization packages or business intelligence tools, Vizro combines benefits of the speed and user-friendliness of low-code visual analytics tools with the flexibility and power of high-code tools, whilst providing inbuilt visual design, application architecture and coding standardization - -The simple and largely declarative configuration language follows a “grammar of dashboards” which makes the creation of complex dashboards more intuitive. This leverages modular components, empowering users to rapidly self-serve the assembly of customized dashboards with inbuilt visual styling in minutes, and reduces the amount of “glue code” required, whilst still retaining the ability to enhance functionality almost infinitely through customization and extensions, with standardization increasing the consistency across outputs. - -Using configuration rather than a GUI to define the output facilitates collaboration during the creation process, and increases reusability and scalability in a Python setting. - -The largely tech-agnostic configuration driven assembly enables utilizing a range of tools, and an inbuilt validation layer provides meaningful feedback to users about configuration choices, thereby increasing flexibility and ease of use. +For an explanation of why you want to use Vizro, please visit the [`Why Vizro section`](https://vizro.readthedocs.io/en/latest/pages/discussion/why_vizro/) of our docs
diff --git a/vizro-core/docs/index.md b/vizro-core/docs/index.md index bf6f22c8c..733b306c8 100644 --- a/vizro-core/docs/index.md +++ b/vizro-core/docs/index.md @@ -37,6 +37,17 @@ Vizro is a toolkit for creating modular data visualization applications + +
+
+
Discussion
+

+ Our discussion section contains background information and the answer to "why" questions. +

+
+
+ +
diff --git a/vizro-core/docs/pages/discussion/why_vizro.md b/vizro-core/docs/pages/discussion/why_vizro.md new file mode 100644 index 000000000..b8a578d7f --- /dev/null +++ b/vizro-core/docs/pages/discussion/why_vizro.md @@ -0,0 +1,9 @@ +# Why Vizro + +In the context of comparison with other visualization packages or business intelligence tools, Vizro combines benefits of the speed and user-friendliness of low-code visual analytics tools with the flexibility and power of high-code tools - whilst providing inbuilt visual design, application architecture and coding standardization which also facilitates scaling and reusability. + +The simple and largely declarative configuration language follows a “grammar of dashboards” which makes the creation of complex dashboards more intuitive. This leverages modular components, empowering users to rapidly self-serve the assembly of customized dashboards with inbuilt visual styling in minutes, and reduces the amount of “glue code” required, whilst still retaining the ability to enhance functionality almost infinitely through customization and extensions, with standardization increasing the consistency across outputs. + +Using configuration rather than a GUI to define the output facilitates collaboration during the creation process, and increases reusability and scalability in a Python setting. + +The largely tech-agnostic configuration driven assembly enables utilizing a range of tools, and an inbuilt validation layer provides meaningful feedback to users about configuration choices, thereby increasing flexibility and ease of use. \ No newline at end of file diff --git a/vizro-core/mkdocs.yml b/vizro-core/mkdocs.yml index 4bf312f4d..caab807b4 100644 --- a/vizro-core/mkdocs.yml +++ b/vizro-core/mkdocs.yml @@ -31,12 +31,13 @@ nav: - Extensions: - Custom Charts: pages/user_guides/custom_charts.md - Custom Components: pages/user_guides/custom_components.md - - API reference: - Vizro: pages/API_reference/vizro.md - Models: pages/API_reference/models.md - Data Manager: pages/API_reference/manager.md - Actions: pages/API_reference/actions.md + - Discussion: + - Why Vizro: pages/discussion/why_vizro.md - Contribute: - Contributing: pages/development/contributing.md - Authors: pages/development/authors.md From 852750d44939bc85b647c4ac4e6873af4a8fbfe8 Mon Sep 17 00:00:00 2001 From: Maximilian Schulz Date: Thu, 28 Sep 2023 12:13:03 +0200 Subject: [PATCH 05/10] add comma authors --- vizro-core/docs/pages/development/authors.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/vizro-core/docs/pages/development/authors.md b/vizro-core/docs/pages/development/authors.md index 5af936c38..c12f94008 100644 --- a/vizro-core/docs/pages/development/authors.md +++ b/vizro-core/docs/pages/development/authors.md @@ -14,8 +14,8 @@ ## Previous team members and code contributors -[Jo Stichbury](https://github.com/stichbury) -[Juan Luis Cano Rodríguez](https://github.com/astrojuanlu) +[Jo Stichbury](https://github.com/stichbury), +[Juan Luis Cano Rodríguez](https://github.com/astrojuanlu), [Denis Lebedev](https://github.com/DenisLebedevMcK), [Qiuyi Chen](https://github.com/Qiuyi-Chen), [Elena Fridman](https://github.com/EllenWie), From dc0cc20b0fbf484987fd64b00a38c69daa262b35 Mon Sep 17 00:00:00 2001 From: Maximilian Schulz Date: Thu, 28 Sep 2023 12:21:03 +0200 Subject: [PATCH 06/10] Improve index --- vizro-core/docs/index.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/vizro-core/docs/index.md b/vizro-core/docs/index.md index 733b306c8..90241a9d0 100644 --- a/vizro-core/docs/index.md +++ b/vizro-core/docs/index.md @@ -1,9 +1,12 @@ # Vizro -Vizro is a toolkit for creating modular data visualization applications +Vizro is a toolkit for creating modular data visualization applications. + +## First time user
+
@@ -15,6 +18,14 @@ Vizro is a toolkit for creating modular data visualization applications
+
+
+ +## Extensive documentation + +
+
+
From 1933d8cbc6fd0b26552b2ee87305f701c719bad5 Mon Sep 17 00:00:00 2001 From: Maximilian Schulz Date: Thu, 28 Sep 2023 12:23:03 +0200 Subject: [PATCH 07/10] changelog --- ...8_maximilian_schulz_introduce_why_vizro.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 vizro-core/changelog.d/20230928_122208_maximilian_schulz_introduce_why_vizro.md diff --git a/vizro-core/changelog.d/20230928_122208_maximilian_schulz_introduce_why_vizro.md b/vizro-core/changelog.d/20230928_122208_maximilian_schulz_introduce_why_vizro.md new file mode 100644 index 000000000..24906aac6 --- /dev/null +++ b/vizro-core/changelog.d/20230928_122208_maximilian_schulz_introduce_why_vizro.md @@ -0,0 +1,42 @@ + + + + +### Added + +- Add a "why Vizro" section to the docs ([#73](https://github.com/mckinsey/vizro/pull/73)) + + + + + + From 4f9ad85c1efc50116d7e9fa919c87dc89576935a Mon Sep 17 00:00:00 2001 From: Maximilian Schulz Date: Thu, 28 Sep 2023 12:24:11 +0200 Subject: [PATCH 08/10] Lint --- .../20230928_122208_maximilian_schulz_introduce_why_vizro.md | 1 - vizro-core/docs/pages/discussion/why_vizro.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/vizro-core/changelog.d/20230928_122208_maximilian_schulz_introduce_why_vizro.md b/vizro-core/changelog.d/20230928_122208_maximilian_schulz_introduce_why_vizro.md index 24906aac6..7f8f232b4 100644 --- a/vizro-core/changelog.d/20230928_122208_maximilian_schulz_introduce_why_vizro.md +++ b/vizro-core/changelog.d/20230928_122208_maximilian_schulz_introduce_why_vizro.md @@ -15,7 +15,6 @@ Uncomment the section that is right (remove the HTML comment wrapper). - Add a "why Vizro" section to the docs ([#73](https://github.com/mckinsey/vizro/pull/73)) -