Skip to main content
Skip to main content

Docs Contribution

This document contribution guide primarily explains how to modify and contribute to the Doris's documents.

Please note that whether it is for historical versions or the latest version of the docs, all modifications should be submitted as pull requests on the apache/doris-website repository.

For how to submit pull requests, please refer to

Doris Website Directory Structure​

.
β”œβ”€β”€ blog
β”‚ β”œβ”€β”€ 1.1 Release.md
β”‚ β”œβ”€β”€ Annoucing.md
β”‚ β”œβ”€β”€ jd.md
β”‚ β”œβ”€β”€ meituan.md
β”‚ β”œβ”€β”€ release-note-0.15.0.md
β”‚ β”œβ”€β”€ release-note-1.0.0.md
β”‚ └── xiaomi.md
β”œβ”€β”€ community
β”‚ β”œβ”€β”€ design
β”‚ β”‚ β”œβ”€β”€ spark_load.md
β”‚ β”‚ β”œβ”€β”€ doris_storage_optimization.md
β”‚ β”‚ β”œβ”€β”€ grouping_sets_design.md
β”‚ β”‚ └── metadata-design.md
β”‚ β”œβ”€β”€ ......
β”œβ”€β”€ docs
β”‚ β”œβ”€β”€ admin-manual
β”‚ β”‚ β”œβ”€β”€ cluster-management
β”‚ β”‚ β”œβ”€β”€ config
β”‚ β”‚ β”œβ”€β”€ data-admin
β”‚ β”‚ β”œβ”€β”€ http-actions
β”‚ β”‚ β”œβ”€β”€ maint-monitor
β”‚ β”‚ β”œβ”€β”€ privilege-ldap
β”‚ β”‚ β”œβ”€β”€ multi-tenant.md
β”‚ β”‚ β”œβ”€β”€ optimization.md
β”‚ β”‚ β”œβ”€β”€ query-profile.md
β”‚ β”‚ └── sql-interception.md
β”‚ β”‚ └── workload-group.md
β”‚ β”œβ”€β”€ ......
β”œβ”€β”€ i18n
β”‚ └── zh-CN
β”‚ β”œβ”€β”€ docusaurus-plugin-content-docs
β”‚ β”‚ β”œβ”€β”€ current
β”‚ β”‚ β”œβ”€β”€ version-1.2
β”‚ β”‚ β”œβ”€β”€ version-2.0
β”‚ β”‚ β”œβ”€β”€ version-2.1
β”‚ β”‚ β”œβ”€β”€ current.json
β”‚ β”‚ β”œβ”€β”€ version-1.2.json
β”‚ β”‚ β”œβ”€β”€ version-2.0.json
β”‚ β”‚ β”œβ”€β”€ version-2.1.json
β”‚ β”œβ”€β”€ docusaurus-plugin-content-docs-community
β”‚ └── local_build_docs.sh
β”œβ”€β”€ src
β”‚ β”œβ”€β”€ components
β”‚ β”‚ β”œβ”€β”€ Icons
β”‚ β”‚ β”œβ”€β”€ More
β”‚ β”‚ β”œβ”€β”€ PageBanner
β”‚ β”‚ └── PageColumn
β”‚ β”œβ”€β”€ ......
β”œβ”€β”€ static
β”‚ β”œβ”€β”€ images
β”‚ β”‚ β”œβ”€β”€ Bloom_filter.svg.png
β”‚ β”‚ β”œβ”€β”€ .....
β”‚ └── js
β”‚ └── redirect.js
β”œβ”€β”€ versioned_docs
β”‚ β”œβ”€β”€ version-1.2
β”‚ β”‚ β”œβ”€β”€ admin-manual
β”‚ β”‚ β”œβ”€β”€ advanced
β”‚ β”‚ β”œβ”€β”€ benchmark
β”‚ β”‚ β”œβ”€β”€ data-operate
β”‚ β”‚ β”œβ”€β”€ data-table
β”‚ β”‚ β”œβ”€β”€ ecosystem
β”‚ β”‚ β”œβ”€β”€ faq
β”‚ β”‚ β”œβ”€β”€ get-starting
β”‚ β”‚ β”œβ”€β”€ install
β”‚ β”‚ β”œβ”€β”€ lakehouse
β”‚ β”‚ β”œβ”€β”€ query-acceleration
β”‚ β”‚ β”œβ”€β”€ releasenotes
β”‚ β”‚ └── sql-manual
β”‚ └── version-2.0
β”‚ β”œβ”€β”€ admin-manual
β”‚ β”œβ”€β”€ benchmark
β”‚ β”œβ”€β”€ data-operate
β”‚ β”œβ”€β”€ db-connect
β”‚ β”œβ”€β”€ ecosystem
β”‚ β”œβ”€β”€ faq
β”‚ β”œβ”€β”€ get-starting
β”‚ β”œβ”€β”€ install
β”‚ β”œβ”€β”€ lakehouse
β”‚ β”œβ”€β”€ query
β”‚ β”œβ”€β”€ releasenotes
β”‚ β”œβ”€β”€ sql-manual
β”‚ └── table-design
└── version-2.1
β”‚ β”œβ”€β”€ admin-manual
β”‚ β”œβ”€β”€ advanced
β”‚ β”œβ”€β”€ benchmark
β”‚ β”œβ”€β”€ data-operate
β”‚ β”œβ”€β”€ data-table
β”‚ β”œβ”€β”€ ecosystem
β”‚ β”œβ”€β”€ faq
β”‚ β”œβ”€β”€ get-starting
β”‚ β”œβ”€β”€ install
β”‚ β”œβ”€β”€ lakehouse
β”‚ β”œβ”€β”€ query-acceleration
β”‚ β”œβ”€β”€ releasenotes
β”‚ └── sql-manual
β”œβ”€β”€ versioned_sidebars
β”‚ β”œβ”€β”€ version-1.2-sidebars.json
β”‚ └── version-2.0-sidebars.json
β”‚ └── version-2.1-sidebars.json
β”œβ”€β”€ babel.config.js
β”œβ”€β”€ build.sh
β”œβ”€β”€ buildVersions.sh
β”œβ”€β”€ docusaurus.config.js
β”œβ”€β”€ package.json
β”œβ”€β”€ README.md
β”œβ”€β”€ sidebars.json
β”œβ”€β”€ sidebarsCommunity.json
β”œβ”€β”€ tree.out
β”œβ”€β”€ tsconfig.json
β”œβ”€β”€ versions.json

The following describes the directory structure of the Doris Website site so that users can easily find the corresponding directory and submit changes.

01 Blog Directory​

The blog directory is located at /blog. All Blog Markdown should be placed in that directory.

If you would like to share your technical insights, welcome to directly submitting a Blog PR or contacting dev@doris.apache.org.

02 Docs Directory​

Here is the list of files if you need to submit docs changes:

  1. Markdown Files: When you want to modify existing content or add new documents, you need to place them to the respective folders and both update Master branch and Version docs (2.1/2.0/1.2) .
  2. Sidebar Files: These files control the directory structures. When adding new files or new directory, you should also update relative path in sidebar files that ensure the new document is displayed correctly in directory. Currently, Master branch and other versions have separate sidebar files, including sidebar.json, version-2.0-sidebars.json, and version-2.1-sidebars.json.

Please make sure to update all the necessary files accordingly when modifying existing document content, adding new documents, or adding new directory sections.

The following are the detailed steps for explaining how and where modify the docs:

Updating Latest Version (Master Branch)

1. Update content

This version is modified in the /docs directory

.
β”œβ”€β”€ docs
β”‚ β”œβ”€β”€ admin-manual
β”‚ β”œβ”€β”€ ......

2. Update sidebar

The docs directory structure of the latest version is edited by sidebar.json.

.
β”œβ”€β”€ docs
β”‚ β”œβ”€β”€ admin-manua
β”‚ β”œβ”€β”€ ......
β”œβ”€β”€ i18n
β”œβ”€β”€ src
β”œβ”€β”€ static
β”œβ”€β”€ versioned_docs
β”œβ”€β”€ versioned_sidebars
β”œβ”€β”€ sidebars.json

Whether add new docs to existing directory or new directory, you need to update the relative path of the added docs in sidebar.json.

{
"docs": [
{
"type": "category",
"label": "Getting Started",
"items": [
"get-starting/quick-start",
"get-starting/what-is-apache-doris"
]
},
{
"type": "category",
"label": "Install and Deploy",
"items": [
"install/standard-deployment",
{
"type": "category",
"label": "Docker Deployment",
"items": [
"install/construct-docker/build-docker-image",
"install/construct-docker/run-docker-cluster"
]
}
......
}
]
}

Updating Version 2.1/2.0/1.2

1. Update content

  • 2.1 version is modified in the /versioned_docs/version-2.1 directory

  • 2.0 version is modified in the /versioned_docs / version-2.0directory

  • 1.2 version is modified in the /versioned_docs / version-1.2 directory

.
β”œβ”€β”€ blog
β”œβ”€β”€ community
β”œβ”€β”€ docs
β”œβ”€β”€ i18n
β”œβ”€β”€ versioned_docs
β”‚ β”œβ”€β”€ version-1.2
β”‚ β”œβ”€β”€ version-2.0
β”‚ β”œβ”€β”€ version-2.1

2. Update sidbar

The docs directory structure of the version docs is edited by version-X.X-sidebar.json.

.
β”œβ”€β”€ blog
β”œβ”€β”€ community
β”œβ”€β”€ docs
β”œβ”€β”€ i18n
β”œβ”€β”€ versioned_docs
β”œβ”€β”€ versioned_sidebars
β”‚ β”œβ”€β”€ version-1.2-sidebars.json
β”‚ └── version-2.0-sidebars.json
β”‚ └── version-2.1-sidebars.json

03 Community Docs Directory​

If you want to modify the community docs, please go to community/ directory.

  • For modifying the existing docs, please go to community/ directory.

  • For updating community docs directory, please modify the sidebarsCommunity.json to include appropriate relative path for the new document.

.
β”œβ”€β”€ blog
β”œβ”€β”€ community
β”‚ β”œβ”€β”€ design
β”‚ β”‚ β”œβ”€β”€ spark_load.md
β”‚ β”‚ β”œβ”€β”€ doris_storage_optimization.md
β”‚ β”‚ β”œβ”€β”€ grouping_sets_design.md
β”‚ β”‚ └── metadata-design.md
β”‚ β”œβ”€β”€ ......
β”‚ ......
β”œβ”€β”€ sidebarsCommunity.json

04 Images Directory​

All images are located at /static/images.

You can display images in simple syntax: ![Alt text for images description](co-locate file structure or link)

If the image file name consists of multiple English words, they should be separated by hyphens "-".

How to write SQL manual​

SQL Manual Docs refer to the documentation under the /sql-manual of Master branch and version docs.

These documents are used in two places:

  1. Official website document.

  2. The output of the HELP command.

In order to support HELP command output, these documents need to be written in strict accordance with the following format, otherwise they will fail the admission check.

An example of the SHOW ALTER command is as follows:

---
{
"title": "SHOW-ALTER",
"language": "en"
}
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## SHOW-ALTER

### Name

SHOW ALTER

### Description

Describe the command sytax

### Example

Support command examples

### Keywords

SHOW, ALTER

### Best Practice

(optionalοΌ‰
Note

The above headings are in English, and pay attention to the level of the headings.