mirror of
https://github.com/apache/superset.git
synced 2024-09-07 06:17:45 -04:00
3e22668f8d
* Restored docs page on roles in security, executed other touchups, and renamed docs readme.txt to readme.md * missed a url anchor on the security page * fixed licensing issue and limited char width to 80 * fixed licensing issue and limited char width to 80 * whitespace experiments * removed 2 periods * staging whitespace * addressed Robs feedback * implemented robs second round of feedback on public_role_like
1.9 KiB
1.9 KiB
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/incubator-superset-site
repository. No need to PR here, simply git push.
# Get in the docs/ folder in the main repo
cd ~/repos/incubator-superset/docs
# have Gatsby build the static website, this puts in under `docs/public`
npm run build
# go to the docs repo
cd ~/repos/incubator-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/incubator-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