google-sre-ebook/README.md

# google-sre-ebook

![Cover](cover.jpg)

Generates a EPUB/MOBI/PDF for the Google SRE Book.

Original sources are downloaded from https://landing.google.com/sre/

# Build

## Docker (Preferred)

Requirements:

- Docker

`docker run --rm --volume "$(pwd):/output" captn3m0/google-sre-ebook:latest`

- You should see the final EPUB/MOBI/PDF files in the `output` directory after the above runs.
- The file may be owned by the root user.

The build for the above Docker image can be audited at <https://cloud.docker.com/swarm/captn3m0/repository/docker/captn3m0/google-sre-ebook/builds>.

## macOS

Review and run the `bootstrap.sh` script to generate the EPUB, MOBI, and PDF files

Requirements:

- Ruby
- `gem install bundler`
- `gem install nokogiri`
- `brew install pandoc`
- `brew cask install calibre`
- `brew install wget`

# Known Issues

- Inline references are not handled in the best possible way
- metadata.xml is not complete. There are just too many authors
- Foreword/Preface is not part of the index

# LICENSE

This is licensed under WTFPL. See COPYING file for the full text.
Initial commit 2017-09-16 16:22:31 +00:00			`# google-sre-ebook`

			`![Cover](cover.jpg)`

Add pdf to the readme 2018-08-03 15:02:20 +00:00			`Generates a EPUB/MOBI/PDF for the Google SRE Book.`
Initial commit 2017-09-16 16:22:31 +00:00
			`Original sources are downloaded from https://landing.google.com/sre/`

Add support for building eBook with Docker This change adds support for building the eBook with Docker. Supporting Docker means that users who want to build the eBook do not have to install Ruby/Bundler/Calibre in their environments. I'm a Docker n00b, so if there's a better way to handle file permissions on the output, I'm all ears. Build tested on Linux. Outputs were fine. There is also a change to the pandoc outputs. It seems the `+smart` extension is not supported for epub/html[0] in their latest versions. [0] - https://pandoc.org/MANUAL.html#extension-smart 2018-05-15 17:41:05 +00:00			`# Build`

Easier Docker workflow 2018-05-16 20:24:54 +00:00			`## Docker (Preferred)`
Initial commit 2017-09-16 16:22:31 +00:00
Working script in ruby 2017-09-16 17:45:59 +00:00			`Requirements:`

Easier Docker workflow 2018-05-16 20:24:54 +00:00			`- Docker`
Updates README 2017-09-16 17:47:03 +00:00
Easier Docker workflow 2018-05-16 20:24:54 +00:00			`docker run --rm --volume "$(pwd):/output" captn3m0/google-sre-ebook:latest`
Add support for building eBook with Docker This change adds support for building the eBook with Docker. Supporting Docker means that users who want to build the eBook do not have to install Ruby/Bundler/Calibre in their environments. I'm a Docker n00b, so if there's a better way to handle file permissions on the output, I'm all ears. Build tested on Linux. Outputs were fine. There is also a change to the pandoc outputs. It seems the `+smart` extension is not supported for epub/html[0] in their latest versions. [0] - https://pandoc.org/MANUAL.html#extension-smart 2018-05-15 17:41:05 +00:00
Add pdf to the readme 2018-08-03 15:02:20 +00:00			- You should see the final EPUB/MOBI/PDF files in the `output` directory after the above runs.
Easier Docker workflow 2018-05-16 20:24:54 +00:00			`- The file may be owned by the root user.`
Add support for building eBook with Docker This change adds support for building the eBook with Docker. Supporting Docker means that users who want to build the eBook do not have to install Ruby/Bundler/Calibre in their environments. I'm a Docker n00b, so if there's a better way to handle file permissions on the output, I'm all ears. Build tested on Linux. Outputs were fine. There is also a change to the pandoc outputs. It seems the `+smart` extension is not supported for epub/html[0] in their latest versions. [0] - https://pandoc.org/MANUAL.html#extension-smart 2018-05-15 17:41:05 +00:00
Easier Docker workflow 2018-05-16 20:24:54 +00:00			`The build for the above Docker image can be audited at <https://cloud.docker.com/swarm/captn3m0/repository/docker/captn3m0/google-sre-ebook/builds>.`
Add support for building eBook with Docker This change adds support for building the eBook with Docker. Supporting Docker means that users who want to build the eBook do not have to install Ruby/Bundler/Calibre in their environments. I'm a Docker n00b, so if there's a better way to handle file permissions on the output, I'm all ears. Build tested on Linux. Outputs were fine. There is also a change to the pandoc outputs. It seems the `+smart` extension is not supported for epub/html[0] in their latest versions. [0] - https://pandoc.org/MANUAL.html#extension-smart 2018-05-15 17:41:05 +00:00
Easier Docker workflow 2018-05-16 20:24:54 +00:00			`## macOS`

Add pdf to the readme 2018-08-03 15:02:20 +00:00			Review and run the `bootstrap.sh` script to generate the EPUB, MOBI, and PDF files
Easier Docker workflow 2018-05-16 20:24:54 +00:00
			`Requirements:`

			`- Ruby`
			- `gem install bundler`
			- `gem install nokogiri`
			- `brew install pandoc`
			- `brew cask install calibre`
			- `brew install wget`
Add support for building eBook with Docker This change adds support for building the eBook with Docker. Supporting Docker means that users who want to build the eBook do not have to install Ruby/Bundler/Calibre in their environments. I'm a Docker n00b, so if there's a better way to handle file permissions on the output, I'm all ears. Build tested on Linux. Outputs were fine. There is also a change to the pandoc outputs. It seems the `+smart` extension is not supported for epub/html[0] in their latest versions. [0] - https://pandoc.org/MANUAL.html#extension-smart 2018-05-15 17:41:05 +00:00
Updates README 2017-09-16 17:47:03 +00:00			`# Known Issues`

			`- Inline references are not handled in the best possible way`
			`- metadata.xml is not complete. There are just too many authors`
			`- Foreword/Preface is not part of the index`
Adds License 2017-09-16 17:52:58 +00:00
			`# LICENSE`

			`This is licensed under WTFPL. See COPYING file for the full text.`