Hi Pinot dev team, Is there anyone I can chat to r...
# pinot-dev
d
Hi Pinot dev team, Is there anyone I can chat to regarding the Pinot Gitbook documentation and how it is hosted on Apache webservers? I’m trying to help another Apache project (Datasketches) do the same thing and would appreciate some help with this, thanks! @Charlie Dickens
x
Hi, we are using gitbook as the tooling to host documentations. gitbook requires a github or gitlib repo to host all the documentation, for pinot, we use: https://github.com/pinot-contrib/pinot-docs We are relying on gitbook hosting pinot docs website and make hyperlinks from each other.
d
Hi @Xiang Fu, Thank you for this - this is very helpful. @Charlie Dickens is a research scientist on the Datasetches team and would like to be in contact with you if that is OK? Are you the best person to talk to? The Datasketches team is an Apache project and they would like to revamp their documentation website. I told them that the Pinot documentation looks clean and is created using Gitbook. The Datasketches team were under the impression that it was an ASF requirement to only host static content on the Apache webserver - but I’m sure the team would be very keen to find out more about how you got the documentation setup and compliant with the ASF rules. Thanks again for the information Xiang.
x
Would love to. Pinot docs are on gitbook from very early days, and I cannot recall the ASF requirement threads. But we definitely did something for DNS domain alias or CNAME thing.
d
Thanks! Really appreciate it. It sounds like there is no need for you to export the documentation as static HTML if you are hosting on Gitbooks, which seems to be an ASF requirement for hosting on their servers. I’ll reach out to Charlie and let him know. There was some confusion in the Datasketches team about the process and they were looking at the Pinot project as an example for an ASF project using Gitbook. A reference issue about the topic is here, and shows a little confusion within the team: https://github.com/apache/datasketches-website/issues/153#issuecomment-1846014856 So I’m glad we could reach out and would appreciate some pointers 🙂
There seems to be an older ASF repo that refers to Docusaurus?
x
oh, yes, pinot website is not on gitbook, only docs are hosted on gitbook https://pinot.apache.org/ is hosted by https://github.com/apache/pinot-site https://docs.pinot.apache.org/ is by gitbook and backed by https://github.com/pinot-contrib/pinot-docs
d
Ah, that makes sense! Thanks, I’ll pass this on to the Datasketches team.
I imagine that you needed to do some CNAME or DNS config to make it appear that the pinot docs were on the apache domain.