You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@doris.apache.org by 黄峰 <fa...@gmail.com> on 2020/04/27 04:02:09 UTC

Re: Re: Documentation website improvement.

Hi all!

As Apache Doris 0.12.0 been released, i'm considering pushing this feature
into all branches. And of course the ASF-SITE REPO
<https://github.com/apache/incubator-doris-website> would be totally
replaced by travis' auto building.

After that the new `Doris's docs` directory will be like:

  .

  ├─ docs/

  │  ├─ .vuepress

  │  │  ├─ dist     // Site distribution files.

  │  │  ├─ public   // Assets

  │  │  ├─ sidebar  // Side bar configurations.

  │  │  │  ├─ en.js

  │  │  │  └─ zh-CN.js

  │  ├─ theme       // Global styles and customizations.

  │  └─ config.js   // Vuepress configurations.

  ├─ zh-CN/

  │  ├─ xxxx.md

  │  └─ README.md   // Will be rendered as entry page.

  └─ en/

     ├─ xxxx.md

     └─ README.md   // Will be rendered as entry page.

The new ASF-SITE structure will be like:

.

├─ master/

│  ├─ en/

│  │  ├─ subfolder

│  │  │  ├─ one.md

│  │  └─ three.md

│  └─ zh-CN/

│      ├─ subfolder

│      │  ├─ one.md

│      └─ three.md

├─ incubating-0.11/

│  ├─ en/

│  │  ├─ subfolder

│  │  │  ├─ one.md

│  │  └─ three.md

│  └─ zh-CN/

│      ├─ subfolder

│      │  ├─ one.md

│      └─ three.md

├─ index.html        // user entry, and auto redirected to master folder

└─ versions.json     // all versions that can be seleted on the website are
defined here



Anyone please feel free to talk, about this improvement.


I would get things done ASAP if there aren't any questions.

And as this PR accepted, a more detailed writing guide would be found under
docs.



Best Regards.