Publishing site using GitBook

[AlexanderSaydakov]

As a part of migration to GitBook we need to understand how do we go from the source code to published ASF site

[leerho]

According to INFRA:
Is it possible to use GitBook as our website?

Is it a static website? If so, then yes, you could set up a github action or similar ci job to build it, then publish via .asf.yaml.

According to GitBook:
Can a website created with GitBook be exported as a static website to another website server?

Yes, a website created with GitBook can be exported as a static website and hosted on another website server. GitBook provides an option to export your content in HTML format, which can then be uploaded to any web server for hosting.

[leerho]

According to GitBook:
How do I export a GitBook website as HTML?

To export a GitBook website as HTML, you can use the "Export as HTML" feature in GitBook. Here are the steps to do it:

1. Open your GitBook website in the GitBook editor.

2. Click on the "Share" button in the top-right corner of the editor.

3. In the share modal, click on the "Export as HTML" option.

4. Wait for the export process to complete.

5. Once the export is finished, you will be able to download a ZIP file containing the HTML version of your GitBook website.

Please note that this feature may not be available on all GitBook plans. Make sure to check if your plan includes the "Export as HTML" feature.

[jmalkin]

Does our account allow that export? With the test repo right now, I think I only see export as PDF.

[leerho]

I'm trying to figure that out. But I can't find the "share" button.

[leerho]

GitBook requires a "Pro" or "Enterprise" account to be able to export HTML.
GitBook is dead.

[c-dickens]

@leerho where did you find this information about Gitbook? I have looked online but can't find any documentation of the above.

[leerho]

I did the following query:
What plans allow exporting GitBook to HTML?

The Pro and Enterprise plans allow exporting GitBook to HTML.

However, none of the 5 sources mention HTML, so this answer is not reliable.

[leerho]

So I went and examined the Pinot website source. link
At the top of the website source README.md is:

This website is built using Docusaurus 2, a modern static website generator.

NOTE: You need to install YARN

So it is not GitBooks.

[leerho]

The yarn link above is old, the new one is yarnpkg.com
It is a JavaScript / Node.js package manager used to manage dependencies in JavaScript projects.

[leerho]

Here is one account of how and why Redux decided to move from GitBooks to Docusaurus
Redux issues 3161

[leerho]

Apparently GitBooks started out as purely open-source, but has now moved towards a commercial product. And from what I have read, this move has made it more problematic for open-source sites.

[davecromberge]

Hi Lee and team,
I've spoken to one of the Pinot team, Xiang Fu, and asked for some clarification on their setup.

The pinot website is not on gitbook, only the docs are hosted on gitbook. In other words:
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

Xiang is happy to take questions from Charlie and myself if you would like more detail and are still interested in this option.

[leerho]

The architecture we are thinking about is something similar.

• Our website front-page would be hosted by apache.org, but we haven't decided on the static-website-generator to use. I see that Pinot is using Docusaurus 2. We would appreciate some feedback about how pleased they are with Docusaurus (pros/cons) and if they considered any other static generators and reasons for choosing Docusaurus.
• Our code docs (Javadocs, Doxygen, Pydoc, etc) will be git-hub pages specific to each language which are separated in their own repos. This seems to work pretty well and can be automated.
• We are looking hard at GitBooks for all the other documentation (Getting started, tutorials, references, etc.). So any feedback on their experience (pros/cons) with GitBooks would also be appreciated.