From fd63ac368773e74a917403e498a082c70caeb650 Mon Sep 17 00:00:00 2001 From: Beto Dealmeida Date: Wed, 24 Mar 2021 19:23:56 -0700 Subject: [PATCH] chore: Update docs for 1.1 (#13732) * Update docs for 1.1 * Update CONTRIBUTING.md Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com> * Update UPDATING.md Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com> * Update UPDATING.md Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com> * Update UPDATING.md Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com> Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com> --- CONTRIBUTING.md | 2 ++ UPDATING.md | 24 +++++++++++++++++++++++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 569c359202..7c80b7ae1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -351,6 +351,8 @@ If the PR passes CI tests and does not have any `need:` labels, it is ready for If an issue/PR has been inactive for >=30 days, it will be closed. If it does not have any status label, add `inactive`. +When creating a PR, if you're aiming to have it included in a specific release, please tag it with the version label. For example, to have a PR considered for inclusion in Superset 1.1 use the label `v1.1`. + ## Reporting a Security Vulnerability Please report security vulnerabilities to private@superset.apache.org. diff --git a/UPDATING.md b/UPDATING.md index a5681789c4..3c276c3e4c 100644 --- a/UPDATING.md +++ b/UPDATING.md @@ -35,7 +35,29 @@ assists people when migrating to a new version. - EMAIL_REPORTS_USER ### Other -[shillelagh](https://github.com/betodealmeida/shillelagh/) is now the recommended module to connect Superset to Google Spreadsheets, since it's more robust and has extensive test coverage. You should uninstall the `gsheetsdb` module and install the `shillelagh` module in its place. Shillelagh is a drop-in replacement, so no modifications are needed to be done on existing queries, datasets or charts. +## 1.1.0 + +### Breaking Changes + +- This is the first release since we adopted semantic versioning ([SIP-57](https://github.com/apache/superset/issues/12566)). There are no breaking changes in 1.1.0 since this is a minor release. + +### Potential Downtime + +- [13111](https://github.com/apache/superset/pull/13111) has a database migration that replaces `directed_force` charts with newer `graph_chart` charts based on Apache ECharts. +- [13216](https://github.com/apache/superset/pull/13216) adds a UUID column to models that are missing it. The original migration script that added the column would incorrectly complete when the column couldn't be added, resulting in a broken schema. The script is optimized for MySQL and Postgres, so depending on the database and the number of objects this migration might take considerable time. +- [12960](https://github.com/apache/superset/pull/12960) populates the granularity parameter in existing charts. Depending on the number of charts without a `granularity` or `granularity_sqla param` this might take considerable time. +- [13052](https://github.com/apache/superset/pull/13052) updates the label in existing pie charts, setting `label_type` from `pie_label_type`. Depending on the number of pie charts this might take considerable time. +- [12680](https://github.com/apache/superset/pull/12680) creates a new table, `dashboard_roles`, for role based dashboard level access. +- [12552](https://github.com/apache/superset/pull/12552) updates charts that have the time range defined using "until" and "since". Depending on the number of charts this might take considerable time. + +### Deprecations + +- [12552](https://github.com/apache/superset/pull/12552) removes the use of unclear time offsets, eg, "30 days". An error message is displayed if the user doesn't specify "ago" or "later", instructing the user of the correct format. +- [12627](https://github.com/apache/superset/pull/12627) deprecates the legacy alerts module. + +### Other + +- [shillelagh](https://github.com/betodealmeida/shillelagh/) is now the recommended module to connect Superset to Google Spreadsheets since it's more robust and has extensive test coverage. You should uninstall the `gsheetsdb` module and install the `shillelagh` module in its place. Shillelagh is a drop-in replacement, so no modifications are needed to be done on existing queries, datasets, or charts. ## 1.0.0