如何为GeoNode的文档提供帮助

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

要为GeoNode文档提供帮助,您应该:

  • 阅读GeoServer样式指南

  • 在GitHub上创建帐户

  • 分叉GeoNode存储库

  • 编辑文件

  • 提交拉取请求

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

风格指南

虽然我们没有严格的文档编写规则,但我们鼓励您在开始编写文档之前阅读GeoServer样式指南:https://docs.geoserver.org/latest/en/docguide/style.html

在GitHub上创建帐户

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

分叉文档存储库

为了进行更改,您首先必须分叉存储库。在网站的右上角,您将找到一个名为“fork”的按钮。

如果您想了解更多有关forking的信息,请访问GitHub官方文档:https://help.github.com/articles/fork-a-repo

在Github上编辑文件

对于较小的更改,您可以使用GitHub网站。将浏览器导航到分叉存储库。要对文件进行更改,请导航到有问题的文件并按 edit 右上角的按钮。

注解

文件是用 重构文本 ,一种轻量级标记语言。要了解如何使用它,请参见:https://docutils.sourceforge.net/docs/user/rst/quickref.html

通过点击 预览 按钮您将能够看到您的更改将是什么样子。要保存更改,请单击 提交更改 在网站的底部。

若要请求文档维护人员集成您的更改,请创建 拉取请求 是需要的。因此,使用 新拉取请求 启动进程的按钮。有关拉取请求的更多信息,请访问GitHub官方文档:https://help.github.com/en/github/collaboration-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

现在您可以启动sphinx开发服务器,该服务器将在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存储库,然后创建一个pull请求,如上所述。