mirror of https://github.com/apache/superset.git
1697e1e3b1
* update docs for new alerts and reporting feature * fix punctuation * fix punctuation * fix punctuation fix bullets fix redis depends on name in docker-compose template * fix bullets * Add extra steps for getting v1.0.1 running step added: Upgrade the db step added: init step added: setup admin fix redis superset naming add . to docker build command * fix worker to use gevent instead of prefork change postgres to internal so it persists on docker-compose down * add comments to superset_config.py * ref: Re-organize a bit and make it easier to read * ref: rm useless level * docs: md changes + more details + kubernetes * docs: Rename to Alerts and Reports * docs: Link to Kubernetes doc * docs: details for docker-compose + minor md changes * docs: fix lists indent * docs: remove unused config * docs: Put detailed config and dockerfile before specific stuff * docs: clean Dockerfiles Co-authored-by: Valentin NOURDIN <vnourdin.externe@bedrockstreaming.com> |
||
|---|---|---|
| .. | ||
| src | ||
| static/images | ||
| .eslintrc.js | ||
| .gitignore | ||
| .htaccess | ||
| .prettierrc | ||
| README.md | ||
| doczrc.js | ||
| gatsby-config.js | ||
| gatsby-node.js | ||
| installation.rst | ||
| package-lock.json | ||
| package.json | ||
| prettier.config.js | ||
| requirements.txt | ||
| sqllab.rst | ||
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
To 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