google-sre-ebook/README.md

69 lines
2.6 KiB
Markdown
Raw Normal View History

2019-02-01 03:43:20 +00:00
# Google SRE Book/s
2017-09-16 16:22:31 +00:00
2019-02-01 03:43:20 +00:00
Generates a EPUB/MOBI/PDF for the Google SRE Book/s.
2017-09-16 16:22:31 +00:00
2019-02-01 03:43:20 +00:00
Original sources are downloaded from https://landing.google.com/sre/books
2017-09-16 16:22:31 +00:00
2019-03-18 16:41:06 +00:00
Visit the [Releases](https://github.com/captn3m0/google-sre-ebook/releases) page to download the latest release.
2019-02-01 03:43:20 +00:00
# Books
2019-04-12 09:57:49 +00:00
| Site Reliability Engineering (2016) | The Site Reliability Workbook (2018) |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a href="https://github.com/captn3m0/google-sre-ebook/releases"><img src="cover/sre-book.jpg" width="320" alt="site reliability engineering cover" /></a> | <a href="https://github.com/captn3m0/google-sre-ebook/releases"><img src="cover/workbook.jpg" width="320" alt="the site reliability workbook cover" /></a> |
2017-09-16 16:22:31 +00:00
# Build
2018-05-16 20:24:54 +00:00
## Docker (Preferred)
2017-09-16 16:22:31 +00:00
2017-09-16 17:45:59 +00:00
Requirements:
- Docker
2017-09-16 17:47:03 +00:00
2019-02-01 05:17:47 +00:00
You can generate either of books using `BOOK_SLUG` variable.
2019-04-12 09:57:49 +00:00
Available values for _`BOOK_SLUG`_:
- `sre_book` Site Reliability Engineering.
- `srw_book` The Site Reliability Workbook.
2019-02-01 05:17:47 +00:00
```
2019-02-03 15:10:03 +00:00
$ docker run --rm --volume "$(pwd):/output" -e BOOK_SLUG='srw_book' captn3m0/google-sre-ebook:latest
```
- You should see the final EPUB/MOBI/PDF files in the current directory after the above runs.
- The file may be owned by the root user.
**NOTE:** You'll have to allow docker access to a directory that's local to your system. The safest way to do this is as follows:
```
$ mkdir /tmp/sreoutput
$ chcon -Rt svirt_sandbox_file_t /tmp/sreoutput
2019-02-03 15:10:03 +00:00
$ docker run --rm --volume "/tmp/sreoutput:/output" -e BOOK_SLUG='srw_book' captn3m0/google-sre-ebook:latest
```
2020-01-11 01:11:07 +00:00
The build for the above Docker image can be audited at <https://hub.docker.com/repository/docker/captn3m0/google-sre-ebook/builds>.
2018-05-16 20:24:54 +00:00
## macOS
2018-08-03 15:02:20 +00:00
Review and run the `bootstrap.sh` script to generate the EPUB, MOBI, and PDF files
2018-05-16 20:24:54 +00:00
Requirements:
- Ruby
- `gem install bundler`
- `bundle install`
- `brew install pandoc`
- `brew cask install calibre`
- `brew install wget`
2017-09-16 17:47:03 +00:00
# Known Issues
- metadata is not complete. There are just too many authors
- Foreword/Preface is not part of the index
- The typesetting is not great and does not match the original. See #22 for a list
2017-09-16 17:52:58 +00:00
# LICENSE
This is licensed under WTFPL. See COPYING file for the full text.