Google Git
Sign in
apache / shardingsphere / refs/tags/4.1.1 / . / docs
tree: eeca3c3ae45020ee748f92eff749a3798edfe086 [path history] [tgz]
  1. blog/
  2. community/
  3. document/
  4. .gitignore
  5. build.sh
  6. LICENSE
  7. Proposal.md
  8. README.md
docs/README.md

ShardingSphere Documents

To build ShardingSphere website by means of hugo and hugo theme learn.

Follow the steps below to deploy ShardingSphere website,

  1. Execute docs/build.sh to generate html files at the directory of docs/target/.
  2. Clone shardingsphere-doc.
  3. Checkout to asf-site branch.
  4. Overwrite document/current with docs/target/document/current, community with docs/target/community and blog with docs/target/blog.
  5. Commit changes and raise a PR for shardingsphere-doc.

Note,

  1. If you modify docs/build.sh, please test it locally.