| <!DOCTYPE html> |
| <html lang="en" class="js csstransforms3d"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> |
| <meta http-equiv="Cache-Control" content="max-age=7200" /> |
| <meta name="generator" content="Hugo 0.70.0" /> |
| <meta name="description" content=""> |
| <meta name="buildDate" content="2021-04-06 18:15:05"> |
| |
| |
| <link rel="shortcut icon" href="https://shardingsphere.apache.org/document/current/img/favicon.png" type="image/x-icon" /> |
| |
| <title>Documents Contributor Guide :: ShardingSphere</title> |
| |
| |
| <link href="https://shardingsphere.apache.org/community/css/nucleus.css?1617704105" rel="stylesheet"> |
| <link href="https://shardingsphere.apache.org/community/css/font-awesome.min.css?1617704105" rel="stylesheet"> |
| <link href="https://shardingsphere.apache.org/community/css/hybrid.css?1617704105" rel="stylesheet"> |
| <link href="https://shardingsphere.apache.org/community/css/featherlight.min.css?1617704105" rel="stylesheet"> |
| <link href="https://shardingsphere.apache.org/community/css/perfect-scrollbar.min.css?1617704105" rel="stylesheet"> |
| <link href="https://shardingsphere.apache.org/community/css/auto-complete.css?1617704105" rel="stylesheet"> |
| <link href="https://shardingsphere.apache.org/community/css/theme.css?1617704105" rel="stylesheet"> |
| <link href="https://shardingsphere.apache.org/community/css/hugo-theme.css?1617704105" rel="stylesheet"> |
| |
| <link href="https://shardingsphere.apache.org/community/css/theme-black.css?1617704105" rel="stylesheet"> |
| |
| |
| <script src="https://shardingsphere.apache.org/community/js/jquery-2.x.min.js?1617704105"></script> |
| |
| <style type="text/css"> |
| :root #header + #content > #left > #rlblock_left{ |
| display:none !important; |
| } |
| |
| </style> |
| |
| |
| </head> |
| <body class="" data-url="/en/contribute/document-contributor/"> |
| <nav id="sidebar" class=""> |
| |
| |
| |
| <div id="header-wrapper"> |
| <div id="header"> |
| <a href="https://shardingsphere.apache.org/"><img src="https://shardingsphere.apache.org/document/current/img/logo_v2.png" /></a> |
| |
| </div> |
| |
| </div> |
| |
| <div class="highlightable"> |
| <ul class="topics"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/" title="Get Involved" class="dd-item |
| parent |
| |
| |
| "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/"> |
| <b>1. </b>Get Involved |
| |
| </a> |
| |
| |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/subscribe/" title="Subscribe Guide" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/subscribe/"> |
| Subscribe Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/contributor/" title="Contributor Guide" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/contributor/"> |
| Contributor Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/committer/" title="Committer Guide" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/committer/"> |
| Committer Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/code-conduct/" title="Code of Conduct" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/code-conduct/"> |
| Code of Conduct |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/issue-conduct/" title="Issue Conduct" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/issue-conduct/"> |
| Issue Conduct |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/document-contributor/" title="Documents Contributor Guide" class="dd-item active"> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/document-contributor/"> |
| Documents Contributor Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/release/" title="ShardingSphere Release Guide" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/release/"> |
| ShardingSphere Release Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/release_ui/" title="ShardingSphere-UI Release Guide" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/release_ui/"> |
| ShardingSphere-UI Release Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/release-elasticjob/" title="ElasticJob Release Guide" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/release-elasticjob/"> |
| ElasticJob Release Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/release-elasticjob-ui/" title="ElasticJob-UI Release Guide" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/release-elasticjob-ui/"> |
| ElasticJob-UI Release Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/2fa/" title="2FA" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/2fa/"> |
| 2FA |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/icla/" title="Sign ICLA Guide" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/icla/"> |
| Sign ICLA Guide |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/contribute/vote/" title="New committer voting process" class="dd-item "> |
| <a href="https://shardingsphere.apache.org/community/en/contribute/vote/"> |
| New committer voting process |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| </ul> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/powered-by/" title="Powered By ShardingSphere" class="dd-item |
| |
| |
| |
| "> |
| <a href="https://shardingsphere.apache.org/community/en/powered-by/"> |
| <b>2. </b>Powered By ShardingSphere |
| |
| </a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/team/" title="Team" class="dd-item |
| |
| |
| |
| "> |
| <a href="https://shardingsphere.apache.org/community/en/team/"> |
| <b>3. </b>Team |
| |
| </a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li data-nav-id="/en/security/" title="security" class="dd-item |
| |
| |
| |
| "> |
| <a href="https://shardingsphere.apache.org/community/en/security/"> |
| <b>4. </b>security |
| |
| </a> |
| |
| |
| </li> |
| |
| |
| |
| |
| |
| </ul> |
| |
| |
| |
| |
| |
| <section id="prefooter"> |
| <hr/> |
| <ul> |
| |
| <li> |
| <a class="padding"> |
| <i class="fa fa-fw fa-language"></i> |
| <div class="select-style"> |
| <select id="select-language" onchange="location = this.value;"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <option id="en" value="/community/en/contribute/document-contributor/" selected>English</option> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <option id="cn" value="/community/cn/contribute/document-contributor/">简体ä¸æ–‡</option> |
| |
| |
| |
| |
| </select> |
| <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" |
| width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve"> |
| <g> |
| <g id="arrow-drop-down"> |
| <polygon points="0,63.75 127.5,191.25 255,63.75 " /> |
| </g> |
| </g> |
| </svg> |
| </div> |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </section> |
| |
| <section id="footer"> |
| <p></p> |
| |
| </section> |
| </div> |
| </nav> |
| |
| |
| |
| |
| |
| <section id="body"> |
| <div id="overlay"></div> |
| <div class="padding highlightable"> |
| |
| <div> |
| <div id="top-bar"> |
| |
| |
| |
| |
| <div id="top-github-link"> |
| <a class="github-link" title='Edit this page' href="https://github.com/apache/shardingsphere/tree/master/docs/community/content/contribute/document-contributor.en.md" target="blank"> |
| <i class="fa fa-code-fork"></i> |
| <span id="top-github-link-text">Edit this page</span> |
| </a> |
| </div> |
| |
| |
| |
| <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb"> |
| <span id="sidebar-toggle-span"> |
| <a href="#" id="sidebar-toggle" data-sidebar-toggle=""> |
| <i class="fa fa-bars"></i> |
| </a> |
| </span> |
| |
| <span class="links"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href='https://shardingsphere.apache.org/community/en/'>ShardingSphere</a> > <a href='https://shardingsphere.apache.org/community/en/contribute/'>Get Involved</a> > Documents Contributor Guide |
| |
| |
| |
| |
| |
| |
| </span> |
| </div> |
| |
| </div> |
| </div> |
| |
| |
| |
| <div id="chapter"> |
| |
| <div id="body-inner"> |
| |
| |
| |
| |
| |
| <p>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.</p> |
| <h2 id="precondition">Precondition</h2> |
| <ul> |
| <li>Familiar with <a href="https://shardingsphere.apache.org">Official website</a>.</li> |
| <li>Familiar with <a href="https://help.github.com/categories/collaborating-with-issues-and-pull-requests/">Collaborating with issues and pull requests</a>.</li> |
| <li>Familiar with <a href="https://www.markdownguide.org/getting-started">Markdown</a>.</li> |
| <li>Familiar with <a href="https://gohugo.io/">Hugo</a>.</li> |
| </ul> |
| <h2 id="fork-document">Fork document</h2> |
| <p>Fork the master branch of <a href="https://github.com/apache/shardingsphere">ShardingSphere</a>.</p> |
| <h2 id="directory-structure-description">Directory structure description</h2> |
| <pre><code>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 |
| </code></pre><h2 id="document-basics">Document Basics</h2> |
| <p>The ShardingSphere document is written in markdown, processed in Hugo, generated HTML, deployed in <a href="https://github.com/apache/shardingsphere-doc/tree/asf-site">asf-site</a> branch, and the source code is located in <a href="https://github.com/apache/shardingsphere/tree/master">Github</a>.</p> |
| <ul> |
| <li><a href="https://shardingsphere.apache.org/document/current/en/overview/">Latest version Official course</a> source is stored in <code>/document/</code>.</li> |
| <li><a href="https://shardingsphere.apache.org/community/en/contribute/">Community introduction and contribution</a> related document sources are stored in <code>/community/content/</code>.</li> |
| </ul> |
| <p>You can submit questions, edit content, and view other people’s changes from <a href="https://github.com/apache/shardingsphere/issues">Github</a>.</p> |
| <h2 id="page-template">Page template</h2> |
| <p>The page template is located in the <code>layouts/partials/</code> directory in themes.</p> |
| <h2 id="ask-specific-and-searchable-questions">Ask specific and searchable questions</h2> |
| <p>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.</p> |
| <p><strong>How to ask questions?</strong></p> |
| <ol> |
| <li>Attach the problem document link.</li> |
| <li>Describe the problem in detail.</li> |
| <li>Describe the problems caused to users.</li> |
| <li>Propose the repair method.</li> |
| <li>In <a href="https://github.com/apache/shardingsphere/issues">Issues</a>,<code>New issue </code> asks your question.</li> |
| </ol> |
| <h2 id="submission-changes">Submission changes</h2> |
| <p><strong>Operation steps:</strong></p> |
| <ol> |
| <li>Locate the file you want to operate in the master branch directory structure.</li> |
| <li>After the file operation is completed, pull request is raised to the master branch.</li> |
| </ol> |
| <h2 id="appointment">Appointment</h2> |
| <ul> |
| <li>Unless otherwise specified, please use Hugo <code>0.70.0</code> version.</li> |
| <li>asf-site branches are updated by the official on a regular basis, you do not need to submit pull request to asf-site.</li> |
| </ul> |
| |
| |
| <footer class=" footline" > |
| |
| </footer> |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| |
| <div id="navigation"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a class="nav nav-prev" href="https://shardingsphere.apache.org/community/en/contribute/issue-conduct/" title="Issue Conduct"> <i class="fa fa-chevron-left"></i></a> |
| |
| |
| <a class="nav nav-next" href="https://shardingsphere.apache.org/community/en/contribute/release/" title="ShardingSphere Release Guide" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a> |
| |
| </div> |
| |
| </section> |
| |
| <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"> |
| <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div> |
| </div> |
| <script src="https://shardingsphere.apache.org/community/js/clipboard.min.js?1617704105"></script> |
| <script src="https://shardingsphere.apache.org/community/js/perfect-scrollbar.min.js?1617704105"></script> |
| <script src="https://shardingsphere.apache.org/community/js/perfect-scrollbar.jquery.min.js?1617704105"></script> |
| <script src="https://shardingsphere.apache.org/community/js/jquery.sticky.js?1617704105"></script> |
| <script src="https://shardingsphere.apache.org/community/js/featherlight.min.js?1617704105"></script> |
| <script src="https://shardingsphere.apache.org/community/js/html5shiv-printshiv.min.js?1617704105"></script> |
| <script src="https://shardingsphere.apache.org/community/js/highlight.pack.js?1617704105"></script> |
| <script>hljs.initHighlightingOnLoad();</script> |
| <script src="https://shardingsphere.apache.org/community/js/modernizr.custom.71422.js?1617704105"></script> |
| <script src="https://shardingsphere.apache.org/community/js/learn.js?1617704105"></script> |
| <script src="https://shardingsphere.apache.org/community/js/hugo-learn.js?1617704105"></script> |
| |
| |
| |
| </body> |
| </html> |
| |
