如何为GeoNode的文档做出贡献¶

如果您想在GeoNode文档中添加或更改某些内容，我们非常欢迎您这样做。由于软件开发的速度很快，文档总是需要改进。

要对GeoNode文档做出贡献，您应该：

阅读Geoserver样式指南
在GitHub上创建帐户
派生GeoNode资料档案库
编辑文件
提交拉式请求

所有这些事情通常都可以在你的浏览器中完成，你不需要下载任何东西。但是，如果您需要添加图像或计划进行更大的更改，则建议在本地工作。

样式指南¶

虽然我们对编写文档没有严格的规定，但我们建议您在开始编写之前阅读Geoserver样式指南：https://docs.geoserver.org/latest/en/docguide/style.html

在GitHub上创建帐户¶

第一步是在GitHub上创建一个帐户。只需转到 Github ，找到适合您的用户名，输入您的电子邮件和密码，然后点击 注册GitHub 。登录后，请访问geonode_Documentation存储库https://github.com/geonode/documentation.

派生文档存储库¶

为了进行更改，您首先必须派生存储库。在网站的右上角，您会发现一个名为“Fork”的按钮来执行此操作。

如果您想阅读更多关于分叉的内容，请访问官方giHub文档：https://help.github.com/articles/fork-a-repo.

在Github上编辑文件¶

对于较小的更改，您可以使用GitHub网站。将浏览器导航到派生的存储库。要对文件进行更改，请导航到有问题的文件，然后单击 edit 按钮在右上角。

注解

文档是用以下格式编写的 重新构造文本 ，一种轻量级的标记语言。要了解如何使用它，请参阅：https://docutils.sourceforge.net/docs/user/rst/quickref.html.

通过击打预览按钮，您将能够看到更改的外观。要保存您的更改，请单击 提交更改 在网站的底部。

要要求文档维护人员集成您的更改，请创建 拉取请求 是需要的。因此，请使用 新的拉取请求 按钮启动该过程。有关拉取请求的更多信息，请访问gihub官方文档：https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests。

本地编辑文件¶

如果您计划对文档结构进行更大的更改，建议在本地进行更改。此外，虽然您可以在主分支上工作，但建议为您的更改创建专用分支。

首先导航到您希望在本地保存存储库的文件夹，然后安装所需的依赖项：：

$ cd /opt
$ git clone https://github.com/your_documentation_repository
$ git remote add upstream https://github.com/geonode/documentation
# add the GeoNode documentation repository as "upstream" source

$ cd your_documentation_repository
$ git fetch upstream;
# get last commits from upstream

$ git merge upstream/master master
# merge the upstream with your fork
# if you like, you can also use 'git pull', which is nothing else than fetching and merging in one step

$ git push
# update your repository at GitHub (origin)

您的存储库现在应该是最新的！有关这些命令的更多信息，请访问https://git-scm.com/docs.让我们安装依赖项：：

$ pip install virtualenv
$ virtualenv docs_env
$ source docs_env/bin/activate
$ pip install sphinx sphinx_rtd_theme sphinx-autobuild

现在您可以启动Shinx开发服务器，该服务器将在https://localhost:8000：：上为您的文档提供服务并进行实时重新加载

$ sphinx-autobuild . _build

完成后，使用以下命令创建构建：

$ make html
# for a last check you can open the index.html in _build subdirectory

创建拉式请求¶

与在浏览器中直接编辑文件一样，您需要创建一个拉入请求，以请求将您的更改集成到主存储库中。：：

$ git status
# will list all changed files

$ git add ...
# add the files of interest

$ git commit -m 'Fixes #1234 Updated docs for ...'
# choose a meaningful commit message

$ git push <branch>

运行这些命令后，将浏览器导航到GitHub存储库，并创建如上所述的拉取请求。