mirror of
https://github.com/apache/superset.git
synced 2024-09-17 11:09:47 -04:00
0a660a1a38
* New branch from superset for integration with firebolt sqlalchemy adapter * Added db_engine_spec file for Firebolt * Removed firebolt code from superset repo * Deleted virtual env commit * Adding time grain changes to firebolt.py * Updated README.md Added steps to install and run Superset with Firebolt SQLAlchemy Adapter * Update README.md Reduced installation steps. Using PyPi installation for adapter now * Revert "Update README.md" This reverts commit |
||
---|---|---|
.. | ||
src | ||
static/images | ||
.asf.yaml | ||
.eslintrc.js | ||
.gitignore | ||
.htaccess | ||
.nvmrc | ||
.prettierrc | ||
doczrc.js | ||
gatsby-config.js | ||
gatsby-node.js | ||
installation.rst | ||
package-lock.json | ||
package.json | ||
prettier.config.js | ||
README.md | ||
requirements.txt | ||
sqllab.rst |
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