IvorySQL全新官方文档正式上线!

We hear you!

为了优化「用户体验」,

小编已经把团队唯一一个

八块腹肌的内核开发贡献出来了,

IvorySQL全新官方文档正式上线!_第1张图片

如果这次更新您还不满意,

下一个就是产品经理!

IvorySQL是一款开源的兼容Oracle的PostgreSQL!旨在「为企业和开发者提供一个高性能、可扩展和安全的数据库解决方案」

在此基础上,「IvorySQL通过兼容Oracle的特性,使得企业能够更便捷地迁移现有的Oracle数据库至IvorySQL,降低了迁移成本和风险」此外,IvorySQL还致力于提供更加优化的性能和更高的可扩展性,以满足不断变化的业务需求。

2023年3月31号IvorySQL官方文档正式上线。在过去的一年中,社区陆陆续续的听到大家对IvorySQL文档建设的呼声,希望可以尽快开展IvorySQL文档建设工作。截止到今日,是时候该给社区朋友们一个交代啦!

目前,IvorySQL中英文文档已部署上线:

https://www.ivorysql.org/zh-CN/

IvorySQL全新文档已上线Antora文档系统:

https://docs.ivorysql.org/index.html

01

/文档构架/

IvorySQL社区提供双语文档。为了「满足不同用户需求」,IvorySQL社区针对文档建设做了改进,全新的文档帮助用户能「快速了解IvorySQL」,并从中找到自己所需的内容。具体的文档结构如下:

  • 发行说明: 包含IvorySQL各个版本的发行说
  • 关于IvorySQL: 包含IvorySQL概述、产品目标和范围、核心特性、竞争优势、技术生态、核心应用场景、主要基本功能、与Oracle的兼容性
  • 入门IvorySQL: 包含IvorySQL入门指南、快速体验、运维人员指南、管理员指南
  • 安装部署: 包含IvorySQL安装概述、安装、卸载IvorySQL数据库
  • 开发者指南: 包含IvorySQL数据库建模、写入数据、事务、SQL参考、Oracle兼容功能、全局唯一索引
  • 运维管理指南: 包含升级IvorySQL版本、管理IvorySQL版本、管理IvorySQL数据库访问、定义数据对象、查询数据、使用外部数据、备份与恢复、装卸数据、性能管理
  • 迁移指南: 包含IvorySQL迁移概述、迁移工具Ora2Pg、迁移Oracle数据库至IvorySQL、迁移门户、数据验证、生成迁移模板
  • 社区贡献指南: 包含IvorySQL社区概述、贡献者指南、提Issue、贡献代码、提交PR、编写文档、提交blog
  • 工具参考: 包含IvorySQL工具一览表、客户端工具、服务器应用
  • FAQ

02

/如何参与IvorySQL文档建设/

‍发展未有穷期,任重而道远。目前文档仍旧在完善当中,「期望有更多用户能参与到文档建设中为IvorySQL生态建设添砖加瓦」IvorySQL社区提供双语文档,您可以为任何一方文档做出贡献,当然您也可以为两方同时做出贡献。

准备工作

(1)下载安装Markdown或者antora

(2)检查源仓库是否有更新,如果有更新请先更新并同步到自己的仓库。如有更新请参阅以下步骤,更新至最新版本:

git  remote
git  fetch  upstream
git  merge  upstream/main
git  push

(3)熟悉样式风格(规范说明)

贡献地方

您可以从以下任何一项开始,以帮助改进IvorySQL网站上的 IvorySQL文档:

(1)编写完善文档

(2)修复拼写错误或格式(标点符号、空格、缩进、代码块等)

(3)修正或更新不当或过时的说明

(4)添加缺少的内容(句子、段落或新文档)

(5)将文档更改从英文翻译成中文,或从中文翻译成英文。

(6)提交、回复和解决文档问题

(7)(高级)查看其他人创建的拉取请求

注:规范说明及示例详细说明请见官网文档

https://www.ivorysql.org/zh-CN/

03

/参与贡献人员/

以下个人作为IvorySQL文档建设者为本版本文档做出了贡献。

  • Cary Huang
  • David Zhang
  • Grant Zhou
  • M.Imran Zaheer
  • 谭洋
  • 王杰
  • 穆帅楠
  • 白京茹
  • 王丽
  • 肖哲凯
  • 王守波
  • 任娇
  • 宋金周
  • 金华建

你可能感兴趣的:(IvorySQL全新官方文档正式上线!)