Skip to content

How to build and publish guidebook

Karsten Wade edited this page Aug 6, 2021 · 1 revision

These steps are the semi-automated method for building the latest AsciiDoc source into HTML and PDF, and publishing it on theopensourceway.org:

  1. Clone the guidebook and theopensourceway_old_website repos to your local system, side by side in the same directory
    • The build/publish scripts expect the repos to be in the same directory.
  2. In the terminal cd into the directory where you have the clone of the guidebook repo.
  3. Make any changes to content in the Asciidoc source, then commit them and push the changes to GitHub.
  4. To build the book for testing your changes, from the command line inside of the guidebook directory, run this command:

    ./build-book.sh

  5. When the script is complete, there will be new PDF and HTML files in the same directory.
  6. To publish the book, run this command, which starts by rebuilding the book, copying it to the website repo, and then committing and pushing to GitHub.

    ./publish-book.sh

  7. Once the script has run, the automation will update theopensourceway.org within a few minutes typically.

If you do not have an sshkey enabled with GitHub, the script will pause and wait for your password entry for the git push step.

Clone this wiki locally