如果您想帮助贡献ShardingSphere文档或网站,我们很乐意为您提供帮助!任何人都可以贡献,无论您是刚接触项目还是已经使用ShardingSphere很长时间,无论是自我认同的开发人员、最终用户,还是那些无法忍受错别字的人,都可以对文档或者网站进行贡献。

在贡献者指南里,已经提到如何提交Issues与Pull Request,这里我们将要介绍如何给官方文档提交Pull Request。

前置条件

Fork文档项目

Fork ShardingSphere的master分支。

目录结构说明

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
  │  │  │      ├─function
  │  │  │      └─use-norms
  │  │  ├─user-manual
  │  │  │  ├─shardingsphere-jdbc
  │  │  │  │  ├─configuration
  │  │  │  │  └─usage
  │  │  │  ├─shardingsphere-proxy
  │  │  │  ├─shardingsphere-scaling
  │  │  │  ├─shardingsphere-sidecar
  │  │  │  └─shardingsphere-ui
  │  │  ├─overview
  │  │  └─quick-start
  │  ├─i18n
  │  ├─layouts
  │  ├─static
  │  └─themes

文档基础知识

ShardingSphere文档使用Markdown编写,并使用Hugo进行处理生成html,部署于asf-site分支,源代码位于Github

您可以从Github网站上提交问题,编辑内容和查看其他人的更改。

页面模板

页面模板位于themes中的 layouts/partials/ 目录中。

提出具体可查找的问题

任何拥有Github帐户的人都可以针对ShardingSphere文档提出问题(错误报告)。如果您发现错误,即使您不知道如何修复它,也应提出问题。

如何提出问题?

  1. 附加出现问题的文档链接。

  2. 详细描述问题。

  3. 描述问题对用户造成的困扰。

  4. 提出建议修复的方式。

  5. IssuesNew issue 提出您的问题。

提交更改

操作步骤如下:

  1. 首先,你需要在master分支目录结构中定位出你要操作的文件。
  2. 文件操作完成后,提pull request到master分支。

约定

  • 非特别说明,请使用Hugo的0.70.0版本

  • asf-site分支由官方定期更新,您无需向asf-site提交pull request