You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@doris.apache.org by luzhijing <54...@qq.com.INVALID> on 2024/03/18 08:56:26 UTC
[Documentation refactoring] optimize the pages and documents on Doris's official website
Hi, Doris Team
The documentation migration work has been completed. From now on, when submitting new documentation or updates, please make sure to do so in the apache/doris-website repository.
The code addresses for different languages and versions of the documentation are as follows:
- English versions (Master Branch): https://github.com/apache/doris-website/tree/master/docs
- English versions (1.2/2.0/2.1 Branch) : https://github.com/apache/doris-website/tree/master/versioned_docs
- Chines versions (Master Branch): https://github.com/apache/doris-website/tree/master/i18n/zh-CN/docusaurus-plugin-content-docs/current
- Chinese versions (1.2/2.0/2.1 Branch): https://github.com/apache/doris-website/tree/master/i18n/zh-CN/docusaurus-plugin-content-docs
To ensure the orderly modification of the overall documentation during the revision process, the merging of documentation PRs should be temporarily handled by me to avoid any oversights.
We welcome any suggestions and collaborators to participate and work together to make Apache Doris even better.
Thanks!
_____
luzhijing@apache.org
------------------ 原始邮件 ------------------
发件人: "luzhijing" <543881514@qq.com>;
发送时间: 2024年3月9日(星期六) 中午11:01
收件人: "dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
主题: 回复： [discuss] optimize the pages and documents on Doris's official website
Hi, Doris Team
It has been some time since our last discussion, and our website and documentation optimization efforts are still ongoing.
We have some recent updates that we need to share with everyone:
1. We will migrate the documentation from the apache/doris[1] repository to the apache/doris-website[2] repository to maintain rapid iteration of the documents. This work will commence next week.
2. We will adjust the overall document structure to present a clearer logic and make it easier for users to read. The modifications will mainly be based on versions 2.0 and 2.1 as the baseline.
3. In addition, there will be optimizations to website functionality and styling, such as improving the ecological tools page[3], optimizing TDK (Title, Description, Keywords) for SEO and something else.
It's important to note that after completing the repository migration, there will be two impacts on everyone.
Firstly, to ensure the orderly modification of the overall documentation during the revision process, I suggest that the merging of documentation PRs should be temporarily handled by one person (me) to avoid any oversights.
Secondly, subsequent code changes and documentation modifications will require separate PRs to be submitted in two different repositories, which may result in some additional work for everyone. However, this is necessary to ensure higher quality documentation.
We welcome any suggestions and collaborators to participate and work together to make Apache Doris even better.
Thanks!
[1] https://github.com/apache/doris
[2] https://github.com/apache/doris-website/
[3] https://doris.apache.org/ecosystem/cluster-management
______
luzhijing@apache.org
------------------ 原始邮件 ------------------
发件人:"luzhijing"<543881514@qq.com>;
发送时间:2023年12月22日(星期五) 凌晨0:20
收件人:"dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
主题:Re: [discuss] optimize the pages and documents on Doris's official website
Hi, Doris Team
It has been a month since the last discussion, and we have made new progress recently.
We have optimized the overall design of the official website, including the style of all pages, the interaction of downloads, the content of documents, and related links.
Therefore, the official website and documents certainly look better. During the modification process, some places may have been accidentally missed, so please feel free to submit issues[1] on github if you find any problems. We will make corrections in a timely manner.
There are still some works in progress, such as the optimization of document structure, the control of document version, and the correction of inaccurate translations.
We look forward to bringing you more exciting features and improvements.
[1] https://github.com/apache/doris-website/issues/364
luzhijing@apache.org
------------------ Original ------------------
From: 543881514 <543881514@qq.com>
Date: Fri,Jul 28,2023 10:32 AM
To: dev <dev@doris.apache.org>, luzhijing <luzhijing@apache.org>
Subject: Re: [discuss] optimize the pages and documents on Doris's official website
Hi, all
Recently, we will optimize the pages and documents on Doris's official website, mainly including the following:
- Updates to homepage slogan and community pages for visual optimization
- Adjust document structure for easier reading and SEO
- User stories will be divided by industry for easy reading by everyone
And there are also some document contents that need to be optimized, I hope these optimizations will help everyone better use Apache Doris.
Thanks!
—
Best Regards
Zhijing Lu
Email:
luzhijing@apache.org
Re:[Documentation refactoring] Introduction to Docs Contribution and Docs Format Specification
Posted by Mingyu Chen <mo...@163.com>.
Nice work!
--
Best Regards
Mingyu Chen
Email:
morningman@apache.org
At 2024-04-01 21:44:15, "luzhijing" <54...@qq.com.INVALID> wrote:
>Hi, Doris Team
>
>
>In order to help everyone get familiar with the new documentation framework more quickly, we have updated the docs contribution[1] and docs format specifications. Please see the link below:
>
>
>[1] Docs Contribution: https://doris.apache.org/community/how-to-contribute/contribute-doc
>
>
>[2] Docs Format Specification: https://doris.apache.org/zh-CN/community/how-to-contribute/docs-format-specification
>
>
>Please refer to the above links for specific details. It's important to note that when modifying existing document content, you need to simultaneously update the latest documentation version on the Master branch and the corresponding versions.
>
>
>When adding new documents, in addition to uploading new Markdown files, you also need to add the link path of the new document to the documentation directory structure.
>
>
>Thanks!
>
>
>
>
>
>
>________
>luzhijing@apache.org
>
>
>------------------ 原始邮件 ------------------
>发件人: "luzhijing" <543881514@qq.com>;
>发送时间: 2024年3月18日(星期一) 下午4:56
>收件人: "dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
>
>主题: [Documentation refactoring] optimize the pages and documents on Doris's official website
>
>
>
>Hi, Doris Team
>
>The documentation migration work has been completed. From now on, when submitting new documentation or updates, please make sure to do so in the apache/doris-website repository.
>
>The code addresses for different languages and versions of the documentation are as follows:
>
>- English versions (Master Branch): https://github.com/apache/doris-website/tree/master/docs
>- English versions (1.2/2.0/2.1 Branch) : https://github.com/apache/doris-website/tree/master/versioned_docs
>- Chines versions (Master Branch): https://github.com/apache/doris-website/tree/master/i18n/zh-CN/docusaurus-plugin-content-docs/current
>- Chinese versions (1.2/2.0/2.1 Branch): https://github.com/apache/doris-website/tree/master/i18n/zh-CN/docusaurus-plugin-content-docs
>
>To ensure the orderly modification of the overall documentation during the revision process, the merging of documentation PRs should be temporarily handled by me to avoid any oversights.
>
>
>We welcome any suggestions and collaborators to participate and work together to make Apache Doris even better.
>Thanks!
>
>
>_____
>luzhijing@apache.org
>
>
>------------------ 原始邮件 ------------------
>发件人:"luzhijing"<543881514@qq.com>;
>发送时间:2024年3月9日(星期六) 中午11:01
>收件人:"dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
>
>主题:回复： [discuss] optimize the pages and documents on Doris's official website
>
>
>Hi, Doris Team
>
>It has been some time since our last discussion, and our website and documentation optimization efforts are still ongoing.
>
>We have some recent updates that we need to share with everyone:
>
>1. We will migrate the documentation from the apache/doris[1] repository to the apache/doris-website[2] repository to maintain rapid iteration of the documents. This work will commence next week.
>2. We will adjust the overall document structure to present a clearer logic and make it easier for users to read. The modifications will mainly be based on versions 2.0 and 2.1 as the baseline.
>3. In addition, there will be optimizations to website functionality and styling, such as improving the ecological tools page[3], optimizing TDK (Title, Description, Keywords) for SEO and something else.
>
>It's important to note that after completing the repository migration, there will be two impacts on everyone.
>
>Firstly, to ensure the orderly modification of the overall documentation during the revision process, I suggest that the merging of documentation PRs should be temporarily handled by one person (me) to avoid any oversights.
>
>Secondly, subsequent code changes and documentation modifications will require separate PRs to be submitted in two different repositories, which may result in some additional work for everyone. However, this is necessary to ensure higher quality documentation.
>
>We welcome any suggestions and collaborators to participate and work together to make Apache Doris even better.
>
>Thanks!
>
>[1] https://github.com/apache/doris
>[2] https://github.com/apache/doris-website/
>[3] https://doris.apache.org/ecosystem/cluster-management
>
>______
>luzhijing@apache.org
>
>
>------------------ 原始邮件 ------------------
>发件人:"luzhijing"<543881514@qq.com>;
>发送时间:2023年12月22日(星期五) 凌晨0:20
>收件人:"dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
>
>主题:Re: [discuss] optimize the pages and documents on Doris's official website
>
>
>Hi, Doris Team
>
>It has been a month since the last discussion, and we have made new progress recently.
>
>We have optimized the overall design of the official website, including the style of all pages, the interaction of downloads, the content of documents, and related links.
>
>Therefore, the official website and documents certainly look better. During the modification process, some places may have been accidentally missed, so please feel free to submit issues[1] on github if you find any problems. We will make corrections in a timely manner.
>
>There are still some works in progress, such as the optimization of document structure, the control of document version, and the correction of inaccurate translations.
>
>We look forward to bringing you more exciting features and improvements.
>
>
>[1] https://github.com/apache/doris-website/issues/364
>
>
>luzhijing@apache.org
>------------------ Original ------------------
>From: 543881514 <543881514@qq.com>
>Date: Fri,Jul 28,2023 10:32 AM
>To: dev <dev@doris.apache.org>, luzhijing <luzhijing@apache.org>
>Subject: Re: [discuss] optimize the pages and documents on Doris's official website
>
>
>Hi, all
>
>Recently, we will optimize the pages and documents on Doris's official website, mainly including the following:
>
>- Updates to homepage slogan and community pages for visual optimization
>- Adjust document structure for easier reading and SEO
>- User stories will be divided by industry for easy reading by everyone
>And there are also some document contents that need to be optimized, I hope these optimizations will help everyone better use Apache Doris.
>
>Thanks!
>
>
>—
>
>Best Regards
>Zhijing Lu
>
>Email:
>luzhijing@apache.org
[Documentation refactoring] Temporarily suspend merging PRs into the 2.1 and master branches in doris-website repo
Posted by luzhijing <54...@qq.com.INVALID>.
Hi, Doris Team
The documentation of version 2.0 has been online for some time and has received a lot of positive feedback from users.
We will initiate documentation refactoring for both the 2.1 and master branches this week and next week.
To ensure that the Diff documents between branches are not lost, I will temporarily suspend merging PRs into the 2.1 and master branches in doris-website repo until the documentation refactoring is complete.
Sorry for any inconvenience this may cause, and we hope for your understanding.
Additionally, the issue of dead links in the documentation will also be effectively resolved soon.
Thanks!
________
luzhijing@apache.org
------------------ 原始邮件 ------------------
发件人: "luzhijing" <543881514@qq.com>;
发送时间: 2024年4月1日(星期一) 晚上9:44
收件人: "dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
主题: [Documentation refactoring] Introduction to Docs Contribution and Docs Format Specification
Hi, Doris Team
In order to help everyone get familiar with the new documentation framework more quickly, we have updated the docs contribution[1] and docs format specifications. Please see the link below:
[1] Docs Contribution: https://doris.apache.org/community/how-to-contribute/contribute-doc
[2] Docs Format Specification: https://doris.apache.org/zh-CN/community/how-to-contribute/docs-format-specification
Please refer to the above links for specific details. It's important to note that when modifying existing document content, you need to simultaneously update the latest documentation version on the Master branch and the corresponding versions.
When adding new documents, in addition to uploading new Markdown files, you also need to add the link path of the new document to the documentation directory structure.
Thanks!
________
luzhijing@apache.org
------------------ 原始邮件 ------------------
发件人:"luzhijing"<543881514@qq.com>;
发送时间:2024年3月18日(星期一) 下午4:56
收件人:"dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
主题: [Documentation refactoring] optimize the pages and documents on Doris's official website
Hi, Doris Team
The documentation migration work has been completed. From now on, when submitting new documentation or updates, please make sure to do so in the apache/doris-website repository.
The code addresses for different languages and versions of the documentation are as follows:
- English versions (Master Branch): https://github.com/apache/doris-website/tree/master/docs
- English versions (1.2/2.0/2.1 Branch) : https://github.com/apache/doris-website/tree/master/versioned_docs
- Chines versions (Master Branch): https://github.com/apache/doris-website/tree/master/i18n/zh-CN/docusaurus-plugin-content-docs/current
- Chinese versions (1.2/2.0/2.1 Branch): https://github.com/apache/doris-website/tree/master/i18n/zh-CN/docusaurus-plugin-content-docs
To ensure the orderly modification of the overall documentation during the revision process, the merging of documentation PRs should be temporarily handled by me to avoid any oversights.
We welcome any suggestions and collaborators to participate and work together to make Apache Doris even better.
Thanks!
_____
luzhijing@apache.org
------------------ 原始邮件 ------------------
发件人:"luzhijing"<543881514@qq.com>;
发送时间:2024年3月9日(星期六) 中午11:01
收件人:"dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
主题:回复： [discuss] optimize the pages and documents on Doris's official website
Hi, Doris Team
It has been some time since our last discussion, and our website and documentation optimization efforts are still ongoing.
We have some recent updates that we need to share with everyone:
1. We will migrate the documentation from the apache/doris[1] repository to the apache/doris-website[2] repository to maintain rapid iteration of the documents. This work will commence next week.
2. We will adjust the overall document structure to present a clearer logic and make it easier for users to read. The modifications will mainly be based on versions 2.0 and 2.1 as the baseline.
3. In addition, there will be optimizations to website functionality and styling, such as improving the ecological tools page[3], optimizing TDK (Title, Description, Keywords) for SEO and something else.
It's important to note that after completing the repository migration, there will be two impacts on everyone.
Firstly, to ensure the orderly modification of the overall documentation during the revision process, I suggest that the merging of documentation PRs should be temporarily handled by one person (me) to avoid any oversights.
Secondly, subsequent code changes and documentation modifications will require separate PRs to be submitted in two different repositories, which may result in some additional work for everyone. However, this is necessary to ensure higher quality documentation.
We welcome any suggestions and collaborators to participate and work together to make Apache Doris even better.
Thanks!
[1] https://github.com/apache/doris
[2] https://github.com/apache/doris-website/
[3] https://doris.apache.org/ecosystem/cluster-management
______
luzhijing@apache.org
------------------ 原始邮件 ------------------
发件人:"luzhijing"<543881514@qq.com>;
发送时间:2023年12月22日(星期五) 凌晨0:20
收件人:"dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
主题:Re: [discuss] optimize the pages and documents on Doris's official website
Hi, Doris Team
It has been a month since the last discussion, and we have made new progress recently.
We have optimized the overall design of the official website, including the style of all pages, the interaction of downloads, the content of documents, and related links.
Therefore, the official website and documents certainly look better. During the modification process, some places may have been accidentally missed, so please feel free to submit issues[1] on github if you find any problems. We will make corrections in a timely manner.
There are still some works in progress, such as the optimization of document structure, the control of document version, and the correction of inaccurate translations.
We look forward to bringing you more exciting features and improvements.
[1] https://github.com/apache/doris-website/issues/364
luzhijing@apache.org
------------------ Original ------------------
From: 543881514 <543881514@qq.com>
Date: Fri,Jul 28,2023 10:32 AM
To: dev <dev@doris.apache.org>, luzhijing <luzhijing@apache.org>
Subject: Re: [discuss] optimize the pages and documents on Doris's official website
Hi, all
Recently, we will optimize the pages and documents on Doris's official website, mainly including the following:
- Updates to homepage slogan and community pages for visual optimization
- Adjust document structure for easier reading and SEO
- User stories will be divided by industry for easy reading by everyone
And there are also some document contents that need to be optimized, I hope these optimizations will help everyone better use Apache Doris.
Thanks!
—
Best Regards
Zhijing Lu
Email:
luzhijing@apache.org
[Documentation refactoring] Introduction to Docs Contribution and Docs Format Specification
Posted by luzhijing <54...@qq.com.INVALID>.
Hi, Doris Team
In order to help everyone get familiar with the new documentation framework more quickly, we have updated the docs contribution[1] and docs format specifications. Please see the link below:
[1] Docs Contribution: https://doris.apache.org/community/how-to-contribute/contribute-doc
[2] Docs Format Specification: https://doris.apache.org/zh-CN/community/how-to-contribute/docs-format-specification
Please refer to the above links for specific details. It's important to note that when modifying existing document content, you need to simultaneously update the latest documentation version on the Master branch and the corresponding versions.
When adding new documents, in addition to uploading new Markdown files, you also need to add the link path of the new document to the documentation directory structure.
Thanks!
________
luzhijing@apache.org
------------------ 原始邮件 ------------------
发件人: "luzhijing" <543881514@qq.com>;
发送时间: 2024年3月18日(星期一) 下午4:56
收件人: "dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
主题: [Documentation refactoring] optimize the pages and documents on Doris's official website
Hi, Doris Team
The documentation migration work has been completed. From now on, when submitting new documentation or updates, please make sure to do so in the apache/doris-website repository.
The code addresses for different languages and versions of the documentation are as follows:
- English versions (Master Branch): https://github.com/apache/doris-website/tree/master/docs
- English versions (1.2/2.0/2.1 Branch) : https://github.com/apache/doris-website/tree/master/versioned_docs
- Chines versions (Master Branch): https://github.com/apache/doris-website/tree/master/i18n/zh-CN/docusaurus-plugin-content-docs/current
- Chinese versions (1.2/2.0/2.1 Branch): https://github.com/apache/doris-website/tree/master/i18n/zh-CN/docusaurus-plugin-content-docs
To ensure the orderly modification of the overall documentation during the revision process, the merging of documentation PRs should be temporarily handled by me to avoid any oversights.
We welcome any suggestions and collaborators to participate and work together to make Apache Doris even better.
Thanks!
_____
luzhijing@apache.org
------------------ 原始邮件 ------------------
发件人:"luzhijing"<543881514@qq.com>;
发送时间:2024年3月9日(星期六) 中午11:01
收件人:"dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
主题:回复： [discuss] optimize the pages and documents on Doris's official website
Hi, Doris Team
It has been some time since our last discussion, and our website and documentation optimization efforts are still ongoing.
We have some recent updates that we need to share with everyone:
1. We will migrate the documentation from the apache/doris[1] repository to the apache/doris-website[2] repository to maintain rapid iteration of the documents. This work will commence next week.
2. We will adjust the overall document structure to present a clearer logic and make it easier for users to read. The modifications will mainly be based on versions 2.0 and 2.1 as the baseline.
3. In addition, there will be optimizations to website functionality and styling, such as improving the ecological tools page[3], optimizing TDK (Title, Description, Keywords) for SEO and something else.
It's important to note that after completing the repository migration, there will be two impacts on everyone.
Firstly, to ensure the orderly modification of the overall documentation during the revision process, I suggest that the merging of documentation PRs should be temporarily handled by one person (me) to avoid any oversights.
Secondly, subsequent code changes and documentation modifications will require separate PRs to be submitted in two different repositories, which may result in some additional work for everyone. However, this is necessary to ensure higher quality documentation.
We welcome any suggestions and collaborators to participate and work together to make Apache Doris even better.
Thanks!
[1] https://github.com/apache/doris
[2] https://github.com/apache/doris-website/
[3] https://doris.apache.org/ecosystem/cluster-management
______
luzhijing@apache.org
------------------ 原始邮件 ------------------
发件人:"luzhijing"<543881514@qq.com>;
发送时间:2023年12月22日(星期五) 凌晨0:20
收件人:"dev"<dev@doris.apache.org>;"luzhijing"<luzhijing@apache.org>;
主题:Re: [discuss] optimize the pages and documents on Doris's official website
Hi, Doris Team
It has been a month since the last discussion, and we have made new progress recently.
We have optimized the overall design of the official website, including the style of all pages, the interaction of downloads, the content of documents, and related links.
Therefore, the official website and documents certainly look better. During the modification process, some places may have been accidentally missed, so please feel free to submit issues[1] on github if you find any problems. We will make corrections in a timely manner.
There are still some works in progress, such as the optimization of document structure, the control of document version, and the correction of inaccurate translations.
We look forward to bringing you more exciting features and improvements.
[1] https://github.com/apache/doris-website/issues/364
luzhijing@apache.org
------------------ Original ------------------
From: 543881514 <543881514@qq.com>
Date: Fri,Jul 28,2023 10:32 AM
To: dev <dev@doris.apache.org>, luzhijing <luzhijing@apache.org>
Subject: Re: [discuss] optimize the pages and documents on Doris's official website
Hi, all
Recently, we will optimize the pages and documents on Doris's official website, mainly including the following:
- Updates to homepage slogan and community pages for visual optimization
- Adjust document structure for easier reading and SEO
- User stories will be divided by industry for easy reading by everyone
And there are also some document contents that need to be optimized, I hope these optimizations will help everyone better use Apache Doris.
Thanks!
—
Best Regards
Zhijing Lu
Email:
luzhijing@apache.org