Skip to content

Commit

Permalink
docs(release): small fixes and deprecate apache docs (#11827)
Browse files Browse the repository at this point in the history
* docs(release): small fixes and deprecate apache docs

* remove last 0.38 reference
  • Loading branch information
dpgaspar authored Nov 26, 2020
1 parent 1591d75 commit 3578410
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 113 deletions.
42 changes: 11 additions & 31 deletions RELEASING/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,23 +77,23 @@ Usage (ZSH):

Example:
```bash
source set_release_env.sh 0.37.0rc1 [email protected]
source set_release_env.sh 0.38.0rc1 [email protected]
```

The script will output the exported variables. Here's example for 0.37.0rc1:
The script will output the exported variables. Here's example for 0.38.0rc1:

```
Set Release env variables
SUPERSET_VERSION=0.37.0
SUPERSET_VERSION=0.38.0
SUPERSET_RC=1
SUPERSET_GITHUB_BRANCH=0.37
SUPERSET_GITHUB_BRANCH=0.38
[email protected]
SUPERSET_VERSION_RC=0.37.0rc1
SUPERSET_RELEASE=apache-superset-incubating-0.37.0
SUPERSET_RELEASE_RC=apache-superset-incubating-0.37.0rc1
SUPERSET_RELEASE_TARBALL=apache-superset-incubating-0.37.0-source.tar.gz
SUPERSET_RELEASE_RC_TARBALL=apache-superset-incubating-0.37.0rc1-source.tar.gz
SUPERSET_TMP_ASF_SITE_PATH=/tmp/incubator-superset-site-0.37.0
SUPERSET_VERSION_RC=0.38.0rc1
SUPERSET_RELEASE=apache-superset-incubating-0.38.0
SUPERSET_RELEASE_RC=apache-superset-incubating-0.38.0rc1
SUPERSET_RELEASE_TARBALL=apache-superset-incubating-0.38.0-source.tar.gz
SUPERSET_RELEASE_RC_TARBALL=apache-superset-incubating-0.38.0rc1-source.tar.gz
SUPERSET_TMP_ASF_SITE_PATH=/tmp/incubator-superset-site-0.38.0
```

## Crafting a source release
Expand Down Expand Up @@ -130,7 +130,7 @@ section for the new release.
Finally bump the version number on `superset-frontend/package.json` (replace with whichever version is being released excluding the RC version):

```json
"version": "0.36.0"
"version": "0.38.0"
```

Commit the change with the version number, then git tag the version with the release candidate and push to the branch:
Expand Down Expand Up @@ -329,23 +329,3 @@ Finally, so the Github UI reflects the latest release, you should create a relea
tag corresponding with the new version. Go to https://github.com/apache/incubator-superset/tags,
click the 3-dot icon and select `Create Release`, paste the content of the ANNOUNCE thread in the
release notes, and publish the new release.

## Post release

#### Refresh documentation website

Every once in a while we want to compile the documentation and publish it.
Here's how to do it.

```bash
./make_docs.sh
```

Superset documentation site is ready at http://localhost:5002

```
$ cd /tmp/incubator-superset-site-${SUPERSET_VERSION}
$ git add .
$ git commit -a -m "New doc version ${SUPERSET_VERSION}"
$ git push origin asf-site
```
55 changes: 0 additions & 55 deletions RELEASING/make_docs.sh

This file was deleted.

26 changes: 0 additions & 26 deletions RELEASING/make_docs_entrypoint.sh

This file was deleted.

2 changes: 1 addition & 1 deletion UPDATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ assists people when migrating to a new version.

* [10887](https://github.com/apache/incubator-superset/pull/10887): Breaking change: The custom cache backend changed in order to support the Flask-Caching factory method approach and thus must be registered as a custom type. See [here](https://flask-caching.readthedocs.io/en/latest/#custom-cache-backends) for specifics.

* [10674](https://github.com/apache/incubator-superset/pull/10674): Breaking change: PUBLIC_ROLE_LIKE_GAMMA was removed is favour of the new PUBLIC_ROLE_LIKE so it can be set it whatever role you want.
* [10674](https://github.com/apache/incubator-superset/pull/10674): Breaking change: PUBLIC_ROLE_LIKE_GAMMA was removed is favour of the new PUBLIC_ROLE_LIKE so it can be set to whatever role you want.

* [10590](https://github.com/apache/incubator-superset/pull/10590): Breaking change: this PR will convert iframe chart into dashboard markdown component, and remove all `iframe`, `separator`, and `markup` slices (and support) from Superset. If you have important data in those slices, please backup manually.

Expand Down

0 comments on commit 3578410

Please sign in to comment.