Skip to content

Commit

Permalink
Merge branch 'main' of github.com:mckinsey/vizro into dev/dashboard_g…
Browse files Browse the repository at this point in the history
…enerator
  • Loading branch information
lingyielia committed Jul 10, 2024
2 parents 543dab3 + f95833c commit 5532bce
Show file tree
Hide file tree
Showing 34 changed files with 404 additions and 242 deletions.
48 changes: 15 additions & 33 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,10 @@ body:
- type: markdown
attributes:
value: >-
Hi there! Thank you so much for taking the time to fill in this bug form. It will be
a valuable contribution to Vizro.
Hi there! Thank you so much for taking the time to fill in this bug report.
As we have limited triage capacity, we'd appreciate it if you could search on Vizro's
existing issues prior to submission to avoid any duplicates. Thanks!
We'd appreciate it if you could search on Vizro's existing issues prior to filing
a bug report to avoid any duplicate tickets, as we have limited maintainer capacity to triage
them. Thanks!
- type: textarea
attributes:
label: Description
description: >-
A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: >-
A clear and concise description of what you expected to happen.
- type: dropdown
attributes:
label: Which package?
Expand All @@ -34,26 +18,25 @@ body:
- vizro-ai
validations:
required: true

- type: input
attributes:
label: Package version
validations:
required: true
- type: input
attributes:
label: Python version
validations:
required: true
- type: input

- type: textarea
attributes:
label: OS
label: Description
description: >-
A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: How to Reproduce
description: Please provide steps to reproduce this bug.
description: Provide steps to reproduce this bug. You can also [use a py.cafe link](https://py.cafe/snippet/vizro/v1) to share your example.
placeholder: |
1. Get package from '...'
2. Then run '...'
Expand All @@ -65,14 +48,13 @@ body:
attributes:
label: Output
description: >-
Provide the output of the steps above, including the commands
If you can, provide the output of the steps above, including the commands
themselves and Vizro's output/traceback etc. If possible,
please also provide a screenshot highlighting the issue.
provide a screenshot highlighting the issue or [link to a py.cafe example](https://py.cafe/snippet/vizro/v1).
If you want to present output from multiple commands, please prefix
the line containing the command with `$ `. Please also ensure that
the "How to reproduce" section contains matching instructions for
reproducing this.
If you want to present output from multiple commands, prefix
the line containing the command with `$ `. Ensure that
the "How to reproduce" section contains matching instructions.
- type: checkboxes
attributes:
Expand Down
28 changes: 4 additions & 24 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,9 @@ body:
- type: markdown
attributes:
value: >-
Hi there! Thank you so much for taking the time to fill in this feature request form.
It will be a valuable contribution to Vizro.
We'd appreciate it if you could search on Vizro's existing issues prior to filing
a feature request to avoid any duplicate tickets, as we have limited maintainer capacity to triage
them. Thanks!
Hi there! Thank you so much for taking the time to fill in this feature request.
As we have limited triage capacity, we'd appreciate it if you could search on Vizro's
existing issues prior to submission to avoid any duplicates. Thanks!
- type: dropdown
attributes:
label: Which package?
Expand All @@ -23,7 +20,7 @@ body:
label: What's the problem this feature will solve?
description: >-
What are you trying to do, that you are unable to achieve with Vizro as it
currently stands?
currently stands? Have you tried to work around the problem using Vizro or other tools?
validations:
required: true

Expand All @@ -37,23 +34,6 @@ body:
validations:
required: true

- type: textarea
attributes:
label: Alternative Solutions
description: >-
Have you tried to workaround the problem using Vizro or other tools? Or a
different approach to solving this issue? Please elaborate here.
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: >-
Add any other context, links, etc. relevant to the feature request.
validations:
required: true

- type: checkboxes
attributes:
label: Code of Conduct
Expand Down
27 changes: 5 additions & 22 deletions .github/ISSUE_TEMPLATE/general-question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,9 @@ body:
- type: markdown
attributes:
value: >-
Hi there! Thank you so much for taking the time to fill in this question form. It will be
a valuable contribution to Vizro.
We'd appreciate it if you could search on Vizro's existing issues prior to filing
a general question to avoid any duplicate tickets, as we have limited maintainer capacity to triage
them. Thanks!
Hi there! Thank you so much for taking the time to fill in this general question.
As we have limited triage capacity, we'd appreciate it if you could search on Vizro's
existing issues prior to submission to avoid any duplicates. Thanks!
- type: textarea
attributes:
Expand All @@ -25,29 +22,15 @@ body:
attributes:
label: Code/Examples
description: >-
Please post any supporting code around your question here.
- type: textarea
attributes:
label: Other information
description: >-
Please provide any attempts on answering the question, or any related information you already found here.
Post any supporting code around your question here or as a [py.cafe link](https://py.cafe/snippet/vizro/v1).
Don't forget to include the package version, if it's relevant.
- type: dropdown
attributes:
label: Which package?
options:
- vizro
- vizro-ai
- type: input
attributes:
label: Package version
- type: input
attributes:
label: Python version
- type: input
attributes:
label: OS

- type: checkboxes
attributes:
Expand Down
2 changes: 0 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,3 @@ updates:
directory: "/"
schedule:
interval: "weekly"
labels:
- "dependencies"
3 changes: 3 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
"Package: Vizro-AI :robot:":
- changed-files:
- any-glob-to-any-file: ["vizro-ai/**/*"]
26 changes: 26 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# This workflow will triage pull requests and apply a label based on the
# paths that are modified in the pull request.
#
# To use this workflow, you will need to set up a .github/labeler.yml
# file with configuration. For more information, see:
# https://github.com/actions/labeler

name: Labeler
on:
pull_request:
branches:
- "main"
paths:
- "vizro-ai/**"

jobs:
label:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write

steps:
- uses: actions/labeler@v4
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

<!--
### Highlights ✨
- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Removed
- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Added
- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Changed
- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Deprecated
- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Fixed
- A bullet item for the Fixed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Security
- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
10 changes: 3 additions & 7 deletions vizro-ai/docs/pages/user-guides/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,7 @@ Use of Vizro-AI requires the use of a large language model. At present, we only

To use OpenAI with Vizro-AI you need an API key, which you can get by [creating an OpenAI account if you don't already have one](https://platform.openai.com/account/api-keys).

!!! note

We recommend that you consult the [third-party API key section of the disclaimer documentation](../explanation/disclaimer.md) documentation.
We recommend that you consult the [third-party API key section of the disclaimer documentation](../explanation/disclaimer.md) documentation.

There are two common ways to set up the API key in a development environment.

Expand Down Expand Up @@ -125,12 +123,10 @@ You should see a return output of the form `x.y.z`.

## Upgrade

Check the [release notes](https://github.com/mckinsey/vizro/blob/main/vizro-ai/CHANGELOG.md) for any notable breaking changes before migrating an existing project.

To change the version of Vizro-AI installed:

```bash
pip install -U vizro_ai
```

!!! tip Check the Vizro-AI release notes

To upgrade safely, check the [release notes](https://github.com/mckinsey/vizro/blob/main/vizro-ai/CHANGELOG.md) for any notable breaking changes before migrating an existing project.
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

<!--
### Highlights ✨
- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Removed
- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Added
- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Changed
- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Deprecated
- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Fixed
- A bullet item for the Fixed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Security
- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Uncomment the section that is right (remove the HTML comment wrapper).

### Fixed

- Remove default icon provision for `vm.NavLink` when the icon count exceeds 9 and a user icon is provided.([#571](https://github.com/mckinsey/vizro/pull/571))
- Remove default icon provision for `vm.NavLink` when the icon count exceeds 9 and a user icon is provided.([#572](https://github.com/mckinsey/vizro/pull/572))

<!--
### Security
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!--
A new scriv changelog fragment.
Uncomment the section that is right (remove the HTML comment wrapper).
-->

<!--
### Highlights ✨
- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Removed
- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Added
- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->

### Changed

- Update `optionHeight` of `vm.Dropdown` dynamically based on character length. ([#574](https://github.com/mckinsey/vizro/pull/574))

<!--
### Deprecated
- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Fixed
- A bullet item for the Fixed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
<!--
### Security
- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
-->
Loading

0 comments on commit 5532bce

Please sign in to comment.