morningman opened a new issue #6336:
URL: https://github.com/apache/incubator-doris/issues/6336
At present, many grammatical help documents of Doris are missing, and some
documents have not been updated for a long time, which makes it inconvenient
for users to view grammatical help.
I sorted out all the grammars currently supported by Doris and established
corresponding documents for all grammars. In order to facilitate management,
these documents are all created in the new directory sql-reference-v2. The
directory structure is as follows:
```
└── sql-statements
├── Account-Management-Statements
├── Cluster-Management-Statements
├── Database-Administration-Statements
├── Data-Definition-Statements
│ ├── Alter
│ ├── Backup-and-Restore
│ ├── Create
│ └── Drop
├── Data-Manipulation-Statements
│ ├── Load
│ └── Manipulation
├── Show-Statements
└── Utility-Statements
```
The content of the grammar help file follows a unified title frame. Take the
CREATE-ROLE.md file as an example:
```
---
{
"title": "CREATE-ROLE",
"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.
-->
## CREATE-ROLE
### Description
### Example
### Keywords
CREATE, ROLE
### Best Practice
```
* Description: used to describe the specific grammar and the description of
each part of the grammar.
* Example: Part of it is used to list specific examples.
* Keywords: Part of it is used to index this document.
* Best Practice: The part mainly contains some additional instructions or
best practices for the grammar.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
