Document custom dashboard creation #6583
Conversation
Co-authored-by: edwin <edwin@bes.au>
|
Cursor Agent can help with this pull request. Just |
Summary of ChangesHello @edmofro, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces significant improvements to the Admin Panel documentation by adding a comprehensive guide for end-users on creating custom dashboards. The new section aims to empower users to effectively utilize the Viz Builder functionality within Tupaia, streamlining the process of generating and managing personalized data visualizations. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds valuable documentation for end-users on how to create custom dashboards. The guide is comprehensive and covers the process from getting access to setting up email summaries. My feedback includes a couple of suggestions to improve the readability and user-friendliness of the documentation, such as making a URL clickable and restructuring a long list of steps for better clarity.
| ### Creating a custom dashboard (end user) | ||
|
|
||
| 1. **Open the Admin Panel with Viz Builder access** | ||
| Sign in at `admin.tupaia.org` and make sure your account is in the “Viz Builder User” permission group. Without it you won’t see the “Add dashboard item” button or the builder screens that follow. |
There was a problem hiding this comment.
For a better user experience, it's good practice to make URLs clickable. The URL admin.tupaia.org is currently formatted as code. I suggest making it a hyperlink.
| Sign in at `admin.tupaia.org` and make sure your account is in the “Viz Builder User” permission group. Without it you won’t see the “Add dashboard item” button or the builder screens that follow. | |
| Sign in at [admin.tupaia.org](https://admin.tupaia.org) and make sure your account is in the “Viz Builder User” permission group. Without it you won’t see the “Add dashboard item” button or the builder screens that follow. |
| 2. **Create dashboard cards in Viz Builder** | ||
| - Go to **Visualisations → Dashboard items** and click **Add dashboard item**. | ||
| - Give the card a unique code, a short name your audience will recognise, choose the permission group that should see it, and pick the visualisation type (chart, table, statistic, etc.). | ||
| - After selecting **Create**, the Viz Builder opens. The left panel lets you choose data steps either through the point-and-click Transform Library or by switching to the JSON editor for fine-grained control. | ||
| - Above the preview area you can choose a **project, location, and date range** or upload a small `.json` test file so the preview uses the same data your users will see. | ||
| - Press the blue **Play** button whenever you want to refresh the preview. Use the **Data Preview** tab to confirm the raw numbers and the **Chart Preview** tab to view the finished card. You can toggle between a guided presentation editor (with an AI assistant) and raw JSON if you need to make precise tweaks. | ||
| - When you are happy, click **Save**, confirm in the modal, and stay on the page or jump back to the Admin Panel once the success message appears. |
There was a problem hiding this comment.
The list of actions under "Create dashboard cards in Viz Builder" describes a sequence of steps. Using a nested ordered list (1., 2., etc.) instead of bullet points (-) would improve readability and make the process easier for the user to follow.
| 2. **Create dashboard cards in Viz Builder** | |
| - Go to **Visualisations → Dashboard items** and click **Add dashboard item**. | |
| - Give the card a unique code, a short name your audience will recognise, choose the permission group that should see it, and pick the visualisation type (chart, table, statistic, etc.). | |
| - After selecting **Create**, the Viz Builder opens. The left panel lets you choose data steps either through the point-and-click Transform Library or by switching to the JSON editor for fine-grained control. | |
| - Above the preview area you can choose a **project, location, and date range** or upload a small `.json` test file so the preview uses the same data your users will see. | |
| - Press the blue **Play** button whenever you want to refresh the preview. Use the **Data Preview** tab to confirm the raw numbers and the **Chart Preview** tab to view the finished card. You can toggle between a guided presentation editor (with an AI assistant) and raw JSON if you need to make precise tweaks. | |
| - When you are happy, click **Save**, confirm in the modal, and stay on the page or jump back to the Admin Panel once the success message appears. | |
| 2. **Create dashboard cards in Viz Builder** | |
| 1. Go to **Visualisations → Dashboard items** and click **Add dashboard item**. | |
| 2. Give the card a unique code, a short name your audience will recognise, choose the permission group that should see it, and pick the visualisation type (chart, table, statistic, etc.). | |
| 3. After selecting **Create**, the Viz Builder opens. The left panel lets you choose data steps either through the point-and-click Transform Library or by switching to the JSON editor for fine-grained control. | |
| 4. Above the preview area you can choose a **project, location, and date range** or upload a small `.json` test file so the preview uses the same data your users will see. | |
| 5. Press the blue **Play** button whenever you want to refresh the preview. Use the **Data Preview** tab to confirm the raw numbers and the **Chart Preview** tab to view the finished card. You can toggle between a guided presentation editor (with an AI assistant) and raw JSON if you need to make precise tweaks. | |
| 6. When you are happy, click **Save**, confirm in the modal, and stay on the page or jump back to the Admin Panel once the success message appears. |
2 participants
Issue #: N/A
Changes:
packages/admin-panel/README.mdwith an end-user guide on how to create custom dashboards in Tupaia, covering steps from accessing Viz Builder to linking cards and setting up email summaries.Screenshots: N/A (Documentation only)