Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add seo redirects for Docs v@ #18092

Merged
merged 44 commits into from
Jan 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
26dc600
fix: handle null values in time-series table (#18039)
Jan 14, 2022
5a74090
cleanup column_type_mappings (#17569)
dungdm93 Jan 14, 2022
7728db7
important change to MakeFile (#18037)
AAfghahi Jan 14, 2022
b565273
Update superset-e2e.yml (#18041)
hughhhh Jan 14, 2022
5da3c45
Revert "Update superset-e2e.yml (#18041)" (#18051)
hughhhh Jan 14, 2022
0b67fe1
feat: Trino Authentications (#17593)
dungdm93 Jan 15, 2022
e53a50a
chore(supeset.utils.core): move all database utils to database utils …
ofekisr Jan 16, 2022
de8a1fa
chore(plugin-chart-echarts): add types to controls (#18059)
villebro Jan 16, 2022
8dea7f5
fix(generator): more cleanup to plugin framework (#18027)
villebro Jan 17, 2022
0c7f728
feat(advanced analytics): support groupby in resample (#18045)
zhaoyongjie Jan 17, 2022
3b64563
fix(dashboard): scope of nativefilter not update (#18048)
stephenLYZ Jan 18, 2022
5bfe2d4
fix(generator): add lockfile and fix styling issues (#18073)
villebro Jan 18, 2022
88db2cc
refactor(sql_lab): SQL Lab Persistent Saved State (#17771)
AAfghahi Jan 18, 2022
4675ca3
refactor(example_data): replace the way the birth_names data is loade…
ofekisr Jan 18, 2022
22896f2
feat: add chart description in info tooltip (#17207)
stephenLYZ Jan 19, 2022
f53a267
Correction of proper names format in README (#18087)
ad-m Jan 19, 2022
f91ebe0
chore: added SEO routes
srinify Jan 19, 2022
810cfc1
fix can't use examples helpers on non app context based environment (…
ofekisr Jan 19, 2022
9e2bc72
chore: split CLI into multiple files (#18082)
betodealmeida Jan 19, 2022
f505094
fix misspelling (#18097)
em0227 Jan 19, 2022
035638c
refactor: sqleditorleftbar to functional (#17807)
JosueLugaro Jan 19, 2022
691486d
fix rat excludes and headers
villebro Jan 20, 2022
5ce79ff
fix(docs): fix path of image for "Create New Chart" (#18089)
ad-m Jan 20, 2022
c3a17a7
Migrate Checkbox story to tsx - see #18100 (#18101)
ad-m Jan 20, 2022
a5e805e
refactor: migrate RowCountLabel to TypeScript & added story (#18105)
ad-m Jan 20, 2022
5fb8b0a
fix: logging warning on dataframe (don't use python's warnings) (#18111)
dpgaspar Jan 20, 2022
1f81292
update changelog and updating for 1.4.0 (#18083)
eschutho Jan 20, 2022
959b15e
feat: Adds a key-value endpoint to store charts form data (#17882)
michael-s-molina Jan 20, 2022
b083b34
fix(explore): fix chart embed code modal glitch (#17843)
stephenLYZ Jan 21, 2022
e9651ea
feat(plugin-chart-echarts): support non-timeseries x-axis (#17917)
villebro Jan 21, 2022
0cec0c9
feat(country-map): added new countries in country-chart-map (#18081)
Hammad-Raza Jan 22, 2022
4b89ac7
chore: migrating storybook jsx to typescript #18100 (#18133)
jayakrishnankk Jan 24, 2022
9fa2812
feat(annotation): add toast feedback to annotation templates (#18116)
kgabryje Jan 24, 2022
d9eef8e
feat(dashboard): add toast feedback to dashboard actions (#18114)
kgabryje Jan 24, 2022
e632193
feat(explore): more toast feedback on user actions in Explore (#18108)
kgabryje Jan 24, 2022
350da92
Docs: fix typo (#18125)
proteusvacuum Jan 24, 2022
c77d24c
fix: undefined error when adding extra sequential color scheme (#18152)
kgabryje Jan 24, 2022
1c0b141
feat: allow assets to be managed externally (#18093)
betodealmeida Jan 24, 2022
fa104fe
chore: use pkg_resources for cleaner config (#18130)
betodealmeida Jan 24, 2022
f018c82
refactor: Moves the Explore form_data endpoint (#18151)
michael-s-molina Jan 25, 2022
2f0fa86
Merge branch 'apache:master' into srini/add_redirects
srinify Jan 25, 2022
53a6ea4
Merge branch 'master' into srini/add_redirects
srinify Jan 25, 2022
0316053
Merge remote-tracking branch 'upstream/docV2' into srini/add_redirects
srinify Jan 25, 2022
3285c10
rebased!
srinify Jan 25, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions .rat-excludes
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,9 @@ apache_superset.egg-info
.*csv
# Generated doc files
env/*
docs/README.md
docs/.htaccess*
docs-v2/README.md
docs-v2/.htaccess*
docs-v2/static/img/logo.svg
docs-v2/static/img/undraw_docusaurus_mountain.svg
docs-v2/static/img/undraw_docusaurus_react.svg
docs-v2/static/img/undraw_docusaurus_tree.svg
.nojekyll
_build/*
_static/*
.buildinfo
Expand Down
9,175 changes: 341 additions & 8,834 deletions CHANGELOG.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ In the event a community member discovers a security flaw in Superset, it is imp

Reverting changes that are causing issues in the master branch is a normal and expected part of the development process. In an open source community, the ramifications of a change cannot always be fully understood. With that in mind, here are some considerations to keep in mind when considering a revert:

- **Availability of the PR author:** If the original PR author or the engineer who merged the code is highly available and can provide a fix in a reasonable timeframe, this would counter-indicate reverting.
- **Availability of the PR author:** If the original PR author or the engineer who merged the code is highly available and can provide a fix in a reasonable time frame, this would counter-indicate reverting.
- **Severity of the issue:** How severe is the problem on master? Is it keeping the project from moving forward? Is there user impact? What percentage of users will experience a problem?
- **Size of the change being reverted:** Reverting a single small PR is a much lower-risk proposition than reverting a massive, multi-PR change.
- **Age of the change being reverted:** Reverting a recently-merged PR will be more acceptable than reverting an older PR. A bug discovered in an older PR is unlikely to be causing widespread serious issues.
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ superset:
# Create an admin user in your metadata database
superset fab create-admin \
--username admin \
--firstname Admin \
--firstname "Admin I."\
--lastname Strator \
--email admin@superset.io \
--password general
Expand Down
21 changes: 17 additions & 4 deletions UPDATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ assists people when migrating to a new version.
- [17556](https://github.com/apache/superset/pull/17556): Bumps mysqlclient from v1 to v2
- [15254](https://github.com/apache/superset/pull/15254): Previously `QUERY_COST_FORMATTERS_BY_ENGINE`, `SQL_VALIDATORS_BY_ENGINE` and `SCHEDULED_QUERIES` were expected to be defined in the feature flag dictionary in the `config.py` file. These should now be defined as a top-level config, with the feature flag dictionary being reserved for boolean only values.
- [17290](https://github.com/apache/superset/pull/17290): Bumps pandas to `1.3.4` and pyarrow to `5.0.0`
- [16660](https://github.com/apache/incubator-superset/pull/16660): The `columns` Jinja parameter has been renamed `table_columns` to make the `columns` query object parameter available in the Jinja context.
- [16711](https://github.com/apache/incubator-superset/pull/16711): The `url_param` Jinja function will now by default escape the result. For instance, the value `O'Brien` will now be changed to `O''Brien`. To disable this behavior, call `url_param` with `escape_result` set to `False`: `url_param("my_key", "my default", escape_result=False)`.
- [17539](https://github.com/apache/superset/pull/17539): all Superset CLI commands (init, load_examples and etc) require setting the FLASK_APP environment variable (which is set by default when `.flaskenv` is loaded)

### Potential Downtime
Expand All @@ -47,14 +45,29 @@ assists people when migrating to a new version.
### Other

- [17589](https://github.com/apache/incubator-superset/pull/17589): It is now possible to limit access to users' recent activity data by setting the `ENABLE_BROAD_ACTIVITY_ACCESS` config flag to false, or customizing the `raise_for_user_activity_access` method in the security manager.
- [16809](https://github.com/apache/incubator-superset/pull/16809): When building the superset frontend assets manually, you should now use Node 16 (previously Node 14 was required/recommended). Node 14 will most likely still work for at least some time, but is no longer actively tested for on CI.
- [17536](https://github.com/apache/superset/pull/17536): introduced a key-value endpoint to store dashboard filter state. This endpoint is backed by Flask-Caching and the default configuration assumes that the values will be stored in the file system. If you are already using another cache backend like Redis or Memchached, you'll probably want to change this setting in `superset_config.py`. The key is `FILTER_STATE_CACHE_CONFIG` and the available settings can be found in Flask-Caching [docs](https://flask-caching.readthedocs.io/en/latest/).
- [17882](https://github.com/apache/superset/pull/17882): introduced a key-value endpoint to store Explore form data. This endpoint is backed by Flask-Caching and the default configuration assumes that the values will be stored in the file system. If you are already using another cache backend like Redis or Memchached, you'll probably want to change this setting in `superset_config.py`. The key is `EXPLORE_FORM_DATA_CACHE_CONFIG` and the available settings can be found in Flask-Caching [docs](https://flask-caching.readthedocs.io/en/latest/).

## 1.4.0

### Breaking Changes

- [16660](https://github.com/apache/superset/pull/16660): The `columns` Jinja parameter has been renamed `table_columns` to make the `columns` query object parameter available in the Jinja context.
- [16711](https://github.com/apache/superset/pull/16711): The `url_param` Jinja function will now by default escape the result. For instance, the value `O'Brien` will now be changed to `O''Brien`. To disable this behavior, call `url_param` with `escape_result` set to `False`: `url_param("my_key", "my default", escape_result=False)`.

### Potential Downtime

### Deprecations

### Other

- [16809](https://github.com/apache/superset/pull/16809): When building the superset frontend assets manually, you should now use Node 16 (previously Node 14 was required/recommended). Node 14 will most likely still work for at least some time, but is no longer actively tested for on CI.

## 1.3.0

### Breaking Changes

- [15909](https://github.com/apache/incubator-superset/pull/15909): a change which
- [15909](https://github.com/apache/superset/pull/15909): a change which
drops a uniqueness criterion (which may or may not have existed) to the tables table. This constraint was obsolete as it is handled by the ORM due to differences in how MySQL, PostgreSQL, etc. handle uniqueness for NULL values.

### Potential Downtime
Expand Down
19 changes: 19 additions & 0 deletions docs-v2/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
Expand Down
1 change: 1 addition & 0 deletions docs-v2/babel.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/

module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
78 changes: 78 additions & 0 deletions docs-v2/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

Expand All @@ -34,6 +35,81 @@ const config = {
favicon: 'img/favicon.ico',
organizationName: 'apache', // Usually your GitHub org/user name.
projectName: 'superset', // Usually your repo name.
plugins: [
[
'@docusaurus/plugin-client-redirects',
{
fromExtensions: ['html', 'htm'],
toExtensions: ['exe', 'zip'],
redirects: [
{
to: '/docs/installation/installing-superset-using-docker-compose',
from: '/installation.html',
},
{
to: '/docs/intro',
from: '/tutorials.html',
},
{
to: '/docs/creating-charts-dashboards/first-dashboard',
from: '/admintutorial.html',
},
{
to: '/docs/creating-charts-dashboards/first-dashboard',
from: '/usertutorial.html',
},
{
to: '/docs/security',
from: '/security.html',
},
{
to: '/docs/installation/sql-templating',
from: '/sqllab.html',
},
{
to: '/docs/installation/sql-templating',
from: '/gallery.html',
},
{
to: '/docs/intro',
from: '/sqllab.html',
},
{
to: '/docs/databases/druid',
from: '/druid.html',
},
{
to: '/docs/miscellaneous/country-map-tools',
from: '/misc.html',
},
{
to: '/docs/miscellaneous/country-map-tools',
from: '/visualization.html',
},
{
to: '/docs/frequently-asked-questions',
from: '/videos.html',
},
{
to: '/docs/frequently-asked-questions',
from: '/faq.html',
},
{
to: '/docs/intro',
from: '/index.html',
},
{
to: '/docs/creating-charts-dashboards',
from: '/tutorial.html',
},
{
to: '/docs/installation/alerts-reports',
from: '/docs/installation/email-reports',
},
],
},
],
],

presets: [
[
Expand Down Expand Up @@ -134,6 +210,8 @@ const config = {
darkTheme: darkCodeTheme,
},
}),


Comment on lines +213 to +214
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: perhaps we don't need these blank lines

};

module.exports = config;
1 change: 1 addition & 0 deletions docs-v2/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"dependencies": {
"@ant-design/icons": "^4.7.0",
"@docusaurus/core": "2.0.0-beta.9",
"@docusaurus/plugin-client-redirects": "^2.0.0-beta.14",
"@docusaurus/preset-classic": "2.0.0-beta.9",
"@emotion/core": "^10.1.1",
"@emotion/styled": "^10.0.27",
Expand Down
19 changes: 19 additions & 0 deletions docs-v2/src/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* Any CSS included here will be global. The classic template
* bundles Infima by default. Infima is a CSS framework designed to
Expand Down
19 changes: 19 additions & 0 deletions docs-v2/src/pages/markdown-page.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

---
title: Markdown page example
---
Expand Down
18 changes: 18 additions & 0 deletions docs-v2/static/img/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading