Dear all??



For problems with the current documentation:


1. Lack of Get Started, allowing users to quickly experience Doris through a 
document.
2. The directory is not clear, users are inconvenient to use, and it is 
difficult to quickly find the documents they need
3. The function instruction part lacks the best practice for changing the 
function, and help, the user does not know where to check the corresponding 
help document when using it
4. The data import module is just a stack of functions, and there is no 
classification according to the actual data source, allowing users to choose 
and use according to their own data sources


In response to the above problems, I have reorganized the documents, as follows:


1. Add a quick start document to allow users to quickly experience Doris, Doris 
download, installation and deployment, table building, query, analysis, etc.
2. Re-divide the directory structure into 11 directories to make the entire 
directory structure clearer. Specifically, I will give a link below for 
everyone to discuss.
3. The content of each function will be rewritten. In addition to briefly 
explaining the principle of changing the function, 1-2 examples will be given 
for each function, so that users can use it quickly. The document does not list 
too many parameter explanations of this function. For specific function 
parameters and more help information, a link to the help document will be given 
at the end of the document. Users can go directly to the help document of this 
function. At the same time, it will give the best practice of this function, 
such as Stream load, which will give the most Optimal batch data volume, batch 
practice interval, etc.
4. Now user usage documents and management and maintenance documents are mixed 
together, and it is very inconvenient for users to find them. This time, they 
will be separated and divided into basic data operations, advanced use, and 
management manuals.
5. The original document lacked an introduction to the basic concepts of Doris 
and the Doris system architecture. This time, this part will be supplemented so 
that users can have a comprehensive understanding of the Doris system 
architecture through official documents.
6. The design document will be merged with the developer manual, and will be 
placed in a separate column with the new official website revision: the 
developer manual
7. The apache community will also be a separate column, not in the doris 
document
8. Doris users will also be separated into a separate column, not in the 
document




I have sorted out the general directory structure for everyone to discuss. For 
the time being, it is only in Chinese, and English is still being sorted out. 
For details, please refer to the following links:
http://123.56.118.34:8080/zh-CN


Brs??
Jiafeng.Zhang
Email:jiafengzh...@apache.org

Reply via email to