贡献文档

    本文档在线托管于 GitHub Pages 服务上。

    若您发现文档中存在内容或格式错误，或者您希望能够贡献新文档，那么您需要在本地安装并配置文档开发环境。本项目的文档是一个 Node.js 工程， 是一个基于 Chrome V8 引擎的 JavaScript 运行时环境。

    您需要在本地准备 Node.js 环境。可以选择在 Node.js 官网 下载 页面下载安装包手动安装，也可以根据您正在使用的操作系统使用下面的命令自动安装。

    macOS

    在 macOS 上可以直接使用 Homebrew贡献文档 - 图5 安装：

    Linux / Windows Subsystem for Linux (WSL)

    在 Linux 上通过 安装 Node 版本管理器 nvm。

    1. curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
    2. command -v nvm

    如果 nvm 已经被成功安装，执行以下命令安装 Node 的 LTS 版本：

    Node.js 安装完毕后，使用如下命令检查安装是否成功：

    1. node -v
    2. npm -v

    在 PolarDB for PostgreSQL 工程的根目录下运行以下命令， 将会根据 package.json 安装所有依赖：

    在 PolarDB for PostgreSQL 工程的根目录下运行以下命令：

    1. npm run docs:dev

    文档开发服务器将运行于 http://localhost:8080/PolarDB-for-PostgreSQL/，打开浏览器即可访问。对 Markdown 文件作出修改后，可以在网页上实时查看变化。

    可以看到，docs/zh/ 目录下是其父级目录除 .vuepress/ 以外的翻版。docs/ 目录中全部为英语文档， 目录下全部是相对应的简体中文文档。

    .vuepress/ 目录下包含文档工程的全局配置信息：

    • config.js：文档配置
    • public/：公共静态资源
    • styles/：文档主题默认样式覆盖

    文档的配置方式请参考 VuePress 2 官方文档的 配置指南。

    1. 新的文档写好后，需要在文档配置中配置路由使其在导航栏和侧边栏中显示（可参考其他已有文档）
    2. 修正一种语言的文档时，也需要顺带修正其他语言的相同文档
    3. 修改文档后，使用 工具对 Markdown 文档进行格式化：

    本文档借助 GitHub Actions 提供 CI 服务。向主分支推送代码时，将触发对 docs/ 目录下文档资源的构建，并将构建结果推送到 分支上。GitHub Pages 服务会自动将该分支上的文档静态资源部署到 Web 服务器上形成文档网站。