+++
title = "官方文档贡献指南"
weight = 5
chapter = true
+++

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

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

## 前置条件

- 熟悉[官方网站](https://shardingsphere.apache.org/index_zh.html)
- 熟悉[GitHub 协同开发流程](https://help.github.com/cn/github/collaborating-with-issues-and-pull-requests)
- 熟练掌握[Markdown](https://help.github.com/cn/github/writing-on-github/basic-writing-and-formatting-syntax)
- 熟悉[Hugo](https://gohugo.io/)

## Fork文档项目

Fork [ShardingSphere](https://github.com/apache/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](https://github.com/apache/shardingsphere-doc/tree/asf-site)分支，源代码位于[Github](https://github.com/apache/shardingsphere/tree/master) 。

- [官方教程最新版本](https://shardingsphere.apache.org/document/current/cn/overview/)源存储在`/document/`
- [社区介绍及贡献](https://shardingsphere.apache.org/community/cn/contribute/)相关文档源都储存在`/community/content/`

您可以从[Github](https://github.com/apache/shardingsphere/issues)网站上提交问题，编辑内容和查看其他人的更改。

## 页面模板

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

## 提出具体可查找的问题

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

**如何提出问题？**

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

1. 详细描述问题。

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

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

1. 在[Issues](https://github.com/apache/shardingsphere/issues)中`New issue` 提出您的问题。

## 提交更改

**操作步骤如下:**

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

## 约定

- 非特别说明，请使用Hugo的`0.70.0`版本

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