Scribd
Upload
314 views3 pages

Mastering Apache Spark PDF

This document provides instructions for generating and deploying a technical documentation site using Antora and GitHub. It recommends using Antora to generate the static site from AsciiDoc source files, then deploying it using Docker and FTP. It also describes using GitHub branches, pull requests, and task lists to manage writing chapters in a collaborative workflow.

Uploaded by

Viren Trivedi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
314 views3 pages

Mastering Apache Spark PDF

This document provides instructions for generating and deploying a technical documentation site using Antora and GitHub. It recommends using Antora to generate the static site from AsciiDoc source files, then deploying it using Docker and FTP. It also describes using GitHub branches, pull requests, and task lists to manage writing chapters in a collaborative workflow.

Uploaded by

Viren Trivedi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 3

Table

of Contents
Introduction 1.1

1
Introduction

The Internals of Apache Spark

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

Generate Site
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.

// remove temporary directories and start afresh


$ rm -rf .cache build

// generate the site


$ docker run -u $UID --privileged -v `pwd`:/antora --rm -t antora/antora --cache-dir=.
/.cache/antora site.yml --stacktrace --pull

// deploy it (ftp to the web hosting server)


$ cd build/site/

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

GitHub Flavored writing flow


AsciiDoc
For the first time I’m using AsciiDoc to write a doc that is ultimately supposed to become the
book about Apache Spark.

GitHub for pull requests and tasks


While on writing route, I’m also aiming at mastering the git(hub) flow to write the book as
described in Living the Future of Technical Writing (with pull requests for chapters, action
items to show progress of each branch and such).

2
Introduction

The branching and task progress features embrace the concept of working on a branch per
chapter and using pull requests with GitHub Flavored Markdown for Task Lists. Once the
tasks are defined, GitHub shows progress of a pull request with number of tasks completed
and progress bar.

Figure 1. Pull request with 4 tasks of which 1 is completed

Atom editor
I couldn’t be me if I didn’t use Atom editor with Asciidoc preview installed.

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

You might also like