docs: add QuickSight user docs

moj-analytical-services · Dec 11, 2024 · aef36bb · aef36bb
1 parent 552bf4d
commit aef36bb
Show file tree

Hide file tree

Showing 14 changed files with 184 additions and 3 deletions.
diff --git a/source/data/curated-databases/data-documentation/index.html.md.erb b/source/data/curated-databases/data-documentation/index.html.md.erb
@@ -1,6 +1,6 @@
 ---
 title: Database Documentation
-weight: 110
+weight: 7
 last_reviewed_on: 2023-03-10
 review_in: 1 year
 show_expiry: true

diff --git a/source/documentation/tools/index.md b/source/documentation/tools/index.md
@@ -15,6 +15,10 @@ Allows you to browse the databases that are available on the Analytical Platform
 ### [GitHub](https://github.com/)
 Online hosting platform for git. Git is a distributed version control system that allows you to track changes in files, while GitHub hosts the Analytical Platform's code.
 
+## Data Visualisation
+### [QuickSight](quicksight)
+Business Intelligence (BI/MI) tool for visualising / dashboarding data.
+
 ## Data Ingest
 
 ### [Data Extractor](https://github.com/ministryofjustice/data-engineering-data-extractor)

diff --git a/source/documentation/tools/quicksight/faqs.md b/source/documentation/tools/quicksight/faqs.md
@@ -0,0 +1,19 @@
+# Frequently Asked Questions
+
+## Can I share the dashboards that I create?
+
+### For consumers
+
+### For collaborators / editor
+
+## I’m already a user of another version of QuickSight on the AP, what should I do if:
+
+### I could do all of my work on the new QuickSight (all of my tables are create-a-derived-table tables)
+
+Export dashboards from other versions of QuickSight
+
+Import dashboards into QuickSight via Control Panel
+
+### I can’t do all of my work on the new QuickSight (some / all of my tables are outside create-a-derived-table)
+
+## SPICE
diff --git a/source/documentation/tools/quicksight/getting-started.md b/source/documentation/tools/quicksight/getting-started.md
@@ -0,0 +1,25 @@
+# Getting Started
+
+## Prerequisites to using QuickSight in Analytical Platform
+
+- [ ] Permission to read datasets available in QuickSight
+- [ ] QuickSight enabled for your user within Analytical Platform Control Panel
+
+### Permissions
+
+You'll need permissions to databases, tables, or domains for datasets produced by Create a Derived Table. These permissions are defined in the data-engineering-database-access repo
+
+> **Q:** How do I know if I should be able to see a particular table/database/domain in QuickSight?  
+
+> **A:** See [What data is on quicksight?](/tools/quicksight/what-data-is-in-quicksight) - TL;DR: databases in the repo that have paths beginning with mojap-derived-tables/prod/models/ in their definitions. (example)
+
+### Enable QuickSight in Analytical Platform Control Panel
+
+[Raise a support request](https://github.com/ministryofjustice/data-platform-support/issues/new/choose) to enable QuickSight for your user
+
+## Accessing QuickSight
+
+- Complete [prerequisites](#prerequisites-to-using-quicksight-in-analytical-platform)
+- Navigate to [QuickSight UI within Control Panel](https://controlpanel.services.analytical-platform.service.justice.gov.uk/quicksight/)
+- Dashboard to your heart’s content / contractual obligation
+
diff --git a/source/documentation/tools/quicksight/index.md b/source/documentation/tools/quicksight/index.md
@@ -0,0 +1,29 @@
+# QuickSight
+
+⚠️ This service is in beta ⚠️
+
+QuickSight is a data visualisation service that allows you to create interactive dashboards and reports from data available to the Analytical Platform.
+
+We’re still in beta so we'd love to get some of you using QuickSight to get your feedback to help guide data visualization best practices in the Ministry of Justice and make sure we can continue to improve the user experience.
+
+## [Overview](/tools/quicksight/overview.html)
+
+- [What is QuickSight](/tools/quicksight/overview.html#what-is-quicksight)
+- [What data is in QuickSight?](/tools/quicksight/overview.html#what-data-is-in-quicksight)
+
+## [Getting Started](/tools/quicksight/getting-started.html)
+
+- [Prerequisites](/tools/quicksight/getting-started.html#prerequisites-to-using-quicksight-in-analytical-platform)
+- [Accessing QuickSight](/tools/quicksight/getting-started.html#accessing-quicksight)
+
+## [Working with QuickSight](/tools/quicksight/working-with-quicksight.html)
+- [Finding datasets](/tools/quicksight/working-with-quicksight.html#finding-datasets)
+- [External QuickSight resources](/tools/quicksight/working-with-quicksight.html)
+- [Publishing dashboards](/tools/quicksight/working-with-quicksight.html)
+- [Sharing dashboards](/tools/quicksight/working-with-quicksight.html)
+
+## [FAQs](/tools/quicksight/faqs.html)
+
+## Resources
+- [aws resources](https://aws.amazon.com/quicksight/resources/)
+- [aws example analysis](https://docs.aws.amazon.com/quicksight/latest/user/example-analysis.html) (dataset requires file upload)
diff --git a/source/documentation/tools/quicksight/overview.md b/source/documentation/tools/quicksight/overview.md
@@ -0,0 +1,13 @@
+# Overview
+
+## What is QuickSight?
+
+QuickSight is a data visualisation service that allows you to create interactive dashboards and reports from data available on the Analytical Platform; straight to your browser, in a reproducible way. All you’ll need to do is connect your data sources and start building your visualizations using QuickSight's interface. QuickSight is packed full of features for analyzing data using various visualization types, so you'll need to get familiar with certain bits of QuickSight functionality. To learn more about QuickSight, take a look at [their documentation](https://docs.aws.amazon.com/quicksight/latest/user/welcome.html). Some of the basics about working with QuickSight in this user guide, but you can also sign up and work through [QuickSight's own examples](https://docs.aws.amazon.com/quicksight/latest/user/quickstart-createanalysis.html).
+
+We’re still in beta so we'd love to get some of you using QuickSight to get your feedback to help guide data visualization best practices in the Ministry of Justice and make sure we can continue to improve the user experience.
+
+## What data is available in QuickSight?
+
+QuickSight is connected to the [`mojap-derived-table` domains](https://github.com/moj-analytical-services/create-a-derived-table/tree/main/mojap_derived_tables/models) published through [Create a Derived Table](/tools/create-a-derived-table). 
+
+If the output from Create a Derived Table goes to the `mojap_derived_tables/prod/models` path in S3, it should be available in QuickSight.
diff --git a/source/documentation/tools/quicksight/working-with-quicksight.md b/source/documentation/tools/quicksight/working-with-quicksight.md
@@ -0,0 +1,36 @@
+# Working with QuickSight
+
+## Finding datasets
+
+Datasets are available via the `Athena` data source in QuickSight: 
+
+>Datasets > New Dataset (top right) > Athena > New Athena data source.
+
+When adding a new dataset via Athena you'll be prompted for a `Data source name`. 
+This is just a descriptive name for the new data source tile for **you** in **your** QuickSight interface.
+
+Here's the advice [from aws](https://docs.aws.amazon.com/quicksight/latest/user/create-a-data-source.html) about naming your Data source:
+> _This name displays on the Amazon QuickSight list of existing data sources, which is at the bottom of the 'Create a Dataset' view. 
+Use a name that makes it easy to distinguish your data sources from other similar data sources._
+
+Unless specified elsewhere for your data, use the default `Athena workgroup`.
+
+Data will be in the default Catalog (`AwsDataCatalog`), and you should only see Databases that your user has access to via the Database Access Repo.
+
+Adding a dataset in this way enables you to add a single table at a time.
+
+You'll be asked if you want to 'Import to [SPICE](https://docs.aws.amazon.com/quicksight/latest/user/managing-spice-capacity.html) for quicker analytics'.  
+This imports the data into memory, rather than querying the data where it lives in S3. Whether to use SPICE or directly query the data is a judgement call, and will likely come down to: 
+- how complex the analysis is
+- the size, format and structure of the underlying data
+- how likely users are to drill down into the dashboards
+- user tolerance for load times while making changes to dashboards
+
+
+## External QuickSight resources
+- [aws resources](https://aws.amazon.com/quicksight/resources/)
+- [aws example analysis](https://docs.aws.amazon.com/quicksight/latest/user/example-analysis.html) (dataset requires file upload)
+
+## Publishing Dashboards
+
+## Sharing Dashboards
diff --git a/source/tools/control-panel.html.md.erb b/source/tools/control-panel.html.md.erb
@@ -1,6 +1,6 @@
 ---
 title: Control Panel
-weight: 10
+weight: 5
 last_reviewed_on: 2022-07-06
 review_in: 1 year
 show_expiry: true

diff --git a/source/tools/data-processing/index.html.md.erb b/source/tools/data-processing/index.html.md.erb
@@ -1,6 +1,6 @@
 ---
 title: Tools for Data Processing
-weight: 5
+weight: 8
 last_reviewed_on: 2024-07-11
 review_in: 1 year
 show_expiry: true

diff --git a/source/tools/quicksight/faqs.html.md.erb b/source/tools/quicksight/faqs.html.md.erb
@@ -0,0 +1,11 @@
+---
+title: FAQs
+weight: 25
+tags: quicksight
+last_reviewed_on: 2024-12-11
+review_in: 2 months
+owner_slack: "#analytical-platform-support"
+owner_slack_workspace: "mojdt"
+---
+
+<%= partial 'documentation/tools/quicksight/faqs' %>
diff --git a/source/tools/quicksight/getting-started.html.md.erb b/source/tools/quicksight/getting-started.html.md.erb
@@ -0,0 +1,11 @@
+---
+title: Getting Started
+weight: 15
+tags: quicksight
+last_reviewed_on: 2024-12-11
+review_in: 2 months
+owner_slack: "#analytical-platform-support"
+owner_slack_workspace: "mojdt"
+---
+
+<%= partial 'documentation/tools/quicksight/getting-started' %>
diff --git a/source/tools/quicksight/index.html.md.erb b/source/tools/quicksight/index.html.md.erb
@@ -0,0 +1,11 @@
+---
+title: QuickSight
+weight: 6
+tags: quicksight
+last_reviewed_on: 2024-12-11
+review_in: 2 months
+owner_slack: "#analytical-platform-support"
+owner_slack_workspace: "mojdt"
+---
+
+<%= partial 'documentation/tools/quicksight/index' %>
diff --git a/source/tools/quicksight/overview.html.md.erb b/source/tools/quicksight/overview.html.md.erb
@@ -0,0 +1,11 @@
+---
+title: QuickSight
+weight: 10
+tags: quicksight
+last_reviewed_on: 2024-12-11
+review_in: 2 months
+owner_slack: "#analytical-platform-support"
+owner_slack_workspace: "mojdt"
+---
+
+<%= partial 'documentation/tools/quicksight/overview' %>
diff --git a/source/tools/quicksight/working-with-quicksight.html.md.erb b/source/tools/quicksight/working-with-quicksight.html.md.erb
@@ -0,0 +1,11 @@
+---
+title: Working with QuickSight
+weight: 20
+tags: quicksight
+last_reviewed_on: 2024-12-11
+review_in: 2 months
+owner_slack: "#analytical-platform-support"
+owner_slack_workspace: "mojdt"
+---
+
+<%= partial 'documentation/tools/quicksight/working-with-quicksight' %>