Akanshgoswami/delta-lake-internals

The Internals of Delta Lake

The Internals of Delta Lake Online Book

The project contains the sources of The Internals of Delta Lake online book.

Toolz

The project uses the following "toolz":

• Delta Lake as it comes from my gurus from the Spark SQL / Structured Streaming crew at Databricks (Michael, TD, Burak, zsxwing, and others)

• Antora which is touted as The Static Site Generator for Tech Writers.

• Asciidoc (with some Asciidoctor)

• GitHub Pages

• Atom editor with Asciidoc preview plugin

• Docker to run the Antora image

It’s all to make things harder…​ekhm…​reach higher levels of writing zen.

Generating Book

In order to generate the book, use the commands as described in Run Antora in a Container.

Below are the steps I’m taking to deploy a new version of the site.

$ docker run -u $UID --privileged -v `pwd`:/antora --rm -t antora/antora antora-playbook.yml

// alternatively and recommended
$ docker run --entrypoint ash --privileged -v `pwd`:/antora --rm -it antora/antora

// Inside the container
/antora # antora version
2.3.3

/antora # antora local-antora-playbook.yml

// On your local computer (outside the container)
$ open .out/local/index.html

IMPORTANT: If your Antora build does not seem to work properly, use docker run …​ --pull. This resets your cache.

Not Sphinx?! Why?

Read Giving up on Read the Docs, reStructuredText and Sphinx.