tree: dd94200bd2422e76159ece8c84a2ba8ff9b3fa4f [path history] [tgz]
  1. .eslintrc.js
  2. .gitignore
  3. .htaccess
  4. .prettierrc
  5. README.md
  6. doczrc.js
  7. gatsby-config.js
  8. gatsby-node.js
  9. installation.rst
  10. package-lock.json
  11. package.json
  12. prettier.config.js
  13. requirements.txt
  14. sqllab.rst
  15. src/
  16. static/
docs/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