superset/docs
Christian Pfarr 333b1371f7
feat: Drill ODBC/JDBC Impersonation feature (#17353)
* Added Drill ODBC Impersonation feature and necessary translations/docs

* Code Cleanup

* add jdbc impersonation_target parameter

* add unittests for DrillEngineSpec.modify_url_for_impersonation method

* reformat test_drill.py with black formatter

* run pre-commit locally

Co-authored-by: Christian Pfarr <Christian.Pfarr@deutschebahn.com>
Co-authored-by: Christian Pfarr <z0ltrix+gitlab@pm.me>
2021-11-10 08:45:16 +02:00
..
src feat: Drill ODBC/JDBC Impersonation feature (#17353) 2021-11-10 08:45:16 +02:00
static/images chore(docs): Manage access to Dashboards (#15413) 2021-06-29 12:46:33 +03:00
.asf.yaml docs: add .asf.yaml (#15931) 2021-07-28 15:32:03 -04:00
.eslintrc.js docs(style): make more responsive for mobile (#10853) 2020-09-14 11:58:45 -07:00
.gitignore docs(new docs site): removes old sphinx doc site with gatsby (#10784) 2020-09-11 22:59:12 -07:00
.htaccess docs: fix redirect from bad find/replace (#12642) 2021-01-20 20:25:01 -08:00
.nvmrc docs: update outdated country map tools instructions (#14027) 2021-04-09 15:15:17 -07:00
.prettierrc docs(new docs site): removes old sphinx doc site with gatsby (#10784) 2020-09-11 22:59:12 -07:00
README.md docs: add publish step (#14304) 2021-04-23 10:43:58 -06:00
doczrc.js docs: add API page to docs using Swagger UI (#11154) 2020-10-04 22:01:36 -07:00
gatsby-config.js docs: Remove gatsby-plugin-offline (#12693) 2021-01-25 12:57:22 -05:00
gatsby-node.js chore: Added rockset and firebird (#13418) 2021-03-03 08:55:59 -05:00
installation.rst refactor: adopt --app as celery global option (#16040) 2021-08-05 06:46:03 +12:00
package-lock.json build(deps): bump lodash from 4.17.19 to 4.17.21 in /docs (#14577) 2021-10-13 16:05:16 -03:00
package.json docs: add .asf.yaml (#15931) 2021-07-28 15:32:03 -04:00
prettier.config.js docs(new docs site): removes old sphinx doc site with gatsby (#10784) 2020-09-11 22:59:12 -07:00
requirements.txt docs(new docs site): removes old sphinx doc site with gatsby (#10784) 2020-09-11 22:59:12 -07:00
sqllab.rst feat: Support feature flag overrides in ephemeral test envs (#14008) 2021-04-08 11:05:59 -07:00

README.md

Here's the source to the documentation hosted at superset.apache.org

The site runs on the Gatsby framework and uses docz for it's Documentation subsection.

Getting Started

cd docs/
npm install
npm run start
# navigate to localhost:8000`

To Publish

Github Actions CI automatically publishes the site after changes are merged to master.

To manually publish, the static site that Gatsby generates needs to be pushed to the asf-site branch on the apache/superset-site repository. No need to PR here, simply git push.

# Get in the docs/ folder in the main repo
cd ~/repos/superset/docs
# have Gatsby build the static website, this puts in under `docs/public`
npm run build

# go to the docs repo
cd ~/repos/superset-site
# checkout the proper branch
git checkout asf-site

# BE CAREFUL WITH THIS COMMAND
# wipe the content of the repo
rm -rf *

# copy the static site here
cp -r ~/repos/superset/docs/public/ ./

# git push
git add .
git commit -m "relevant commit msg"
git push origin asf-site

# SUCCESS - it should take minutes to take effect on superset.apache.org