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:
- 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) .
- 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
directory2.0 version is modified in the
/versioned_docs / version-2.0
directory1.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:
Official website document.
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οΌ
The above headings are in English, and pay attention to the level of the headings.