162 Star 219 Fork 1.2K

openGauss / docs

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.en.md
MIT

docs

English | 简体中文

Introduction

Welcome to the repository of openGauss official documentation. This repository provides all documents presented on the openGauss community website, including the legal statement, release notes, product description, technical white paper, compilation guide, quick start, installation guide, administrator guide, developer guide, and tool reference.

Contributions

We welcome your contributions. If you want to participate in the community documentation development, read the Contribution Scope. You must comply with the document writing specifications and submit the document according to the process rules. After the application is approved, the modification will be displayed on the document project and official website.

If you have any comments or suggestions on the document, please submit them in Issues.

Searching for a Document

Open the content folder, which contains documents of the openGauss Lite and enterprise editions.

  • The content/docs-lite folder contains the openGauss Lite documents in Chinese (in the zh folder) and English (in the en folder).
  • The content/zh and content/en folders contain openGauss enterprise edition documents in Chinese and English, respectively.

In the en folder, the docs folder contains specific document contents, and the menu folder contains the document outlines. Open the docs folder. The mapping between manuals and folders is as follows:

Folder Name Manual
Administratorguide Administrator Guide
Compilationguide Compilation Guide
Description Product Description
Developerguide Developer Guide
Glossary Glossary
installation Installation Guide
Quickstart Quick Start
BriefTutorial Brief Tutorial
Releasenotes Release Notes
Technicalwhitepaper Technical White Paper
Toolreference Tool Reference
CharacteristicDescription Characteristic Description
FAQ FAQ

Version Branch Mapping

Docs contains the following seven branches:

Members

Maintainer list:

  • kangyang(@ylfan96)
  • gongsiyi(@gongsiyi150)

Contact Us

The MIT License (MIT) Copyright (c) 2016 DevCows Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

openGauss documentation expand collapse
MIT
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
1
https://gitee.com/opengauss/docs.git
git@gitee.com:opengauss/docs.git
opengauss
docs
docs
master

Search