Is there specification how to build docs/ and update https://gluten.apache.org/?

[zjuwangg]

I have looked through the doc and seems there is no specification on how to build doc locally. Also find that the official website https://gluten.apache.org/ is not consistent with the doc/ .
I think it's important to keep doc up to date and always keep an eye on the document construction to attract more user and developers.

[zhztheplayer]

The site is backed by https://github.com/apache/incubator-gluten-site.

I think it's important to keep doc up to date and always keep an eye on the document construction to attract more user and developers.

+1. It's great if we can host source files in a single place at first, say, only in https://github.com/apache/incubator-gluten-site or in https://github.com/apache/incubator-gluten.

[zjuwangg]

The site is backed by https://github.com/apache/incubator-gluten-site.

I think it's important to keep doc up to date and always keep an eye on the document construction to attract more user and developers.

+1. It's great if we can host source files in a single place at first, say, only in https://github.com/apache/incubator-gluten-site or in https://github.com/apache/incubator-gluten.

Thanks for the reply.
Strongly +1 for the idea that place document in a single place and make the publish of document as a daily work.

Many awesome projects like spark docs and flink docs adopt this way.

[zjuwangg]

make the publish of document as a daily work.

Also we should maintain the version of doc to match different gluten release version.

[zjuwangg]

cc @weiting-chen

[weiting-chen]

Current policy is
The official released document into the official website: https://gluten.apache.org and the source code is maintained in https://github.com/apache/incubator-gluten-site
The latest doc. in main branch, please go to https://apache.github.io/incubator-gluten/ and the code is maintained in https://github.com/apache/incubator-gluten/tree/main/docs

[weiting-chen]

BTW, I am working on a better way to automatically sync up the repository from incubator-gluten to incubator-gluten-site with low efforts to maintain the code between both repositories.

[zjuwangg]

BTW, I am working on a better way to automatically sync up the repository from incubator-gluten to incubator-gluten-site with low efforts to maintain the code between both repositories.

Thanks. I think it's also better to have a link of main branch document in official website document

[zjuwangg]

@weiting-chen Can you share how to build document locally, so that developers can preview their modification to the docs part locally.

[FelixYBW]

Rong and I talked to have an automatic way to create the coverage doc. The function and op support aren't up to date either