If you want to help contribute shardingsphere documents or websites, we are happy to help you! Anyone can contribute, whether you’re new to a project or have been using shardingsphere for a long time, whether you’re a self identified developer, end-user, or someone who can’t stand typos,can contribute to documents or websites. In the contributor guide, we have mentioned how to submit Issues and pull request. here we will introduce how to submit pull request to document.

Precondition

Fork document

Fork the master branch of ShardingSphere.

Directory structure description

shardingsphere
├─docs
  ├─community
  │  ├─archetypes
  │  ├─content
  │  │  ├─users
  │  │  ├─contribute
  │  │  ├─team
  │  │  └─security
  │  ├─layouts
  │  ├─static
  │  └─themes
  ├─document
  │  ├─archetypes
  │  ├─content
  │  │  ├─dev-manual
  │  │  ├─downloads
  │  │  ├─faq
  │  │  ├─features
  │  │  │  ├─encrypt
  │  │  │  ├─governance
  │  │  │  ├─pluggable-architecture
  │  │  │  ├─replica-query
  │  │  │  ├─consensus-replica
  │  │  │  ├─scaling
  │  │  │  ├─shadow
  │  │  │  ├─sharding
  │  │  │  │  ├─concept
  │  │  │  │  ├─principle
  │  │  │  │  └─use-norms
  │  │  │  ├─test-engine
  │  │  │  └─transaction
  │  │  │      ├─concept
  │  │  │      ├─principle
  │  │  │      └─use-norms
  │  │  ├─user-manual
  │  │  │  ├─shardingsphere-jdbc
  │  │  │  │  ├─configuration
  │  │  │  │  └─usage
  │  │  │  ├─shardingsphere-proxy
  │  │  │  ├─shardingsphere-scaling
  │  │  │  ├─shardingsphere-sidecar
  │  │  │  └─shardingsphere-ui
  │  │  ├─overview
  │  │  └─quick-start
  │  ├─i18n
  │  ├─layouts
  │  ├─static
  │  └─themes

Document Basics

The ShardingSphere document is written in markdown, processed in Hugo, generated HTML, deployed in asf-site branch, and the source code is located in Github.

You can submit questions, edit content, and view other people’s changes from Github.

Page template

The page template is located in the layouts/partials/ directory in themes.

Ask specific and searchable questions

Anyone with a GitHub account can ask questions (error reports) about shardingsphere documents. If you find an error, ask questions even if you don’t know how to fix it.

How to ask questions?

  1. Attach the problem document link.
  2. Describe the problem in detail.
  3. Describe the problems caused to users.
  4. Propose the repair method.
  5. In Issues,New issue asks your question.

Submission changes

Operation steps:

  1. Locate the file you want to operate in the master branch directory structure.
  2. After the file operation is completed, pull request is raised to the master branch.

Appointment

  • Unless otherwise specified, please use Hugo 0.70.0 version.
  • asf-site branches are updated by the official on a regular basis, you do not need to submit pull request to asf-site.