|
1 | 1 | # How to generate the InnerSource Patterns gitbook |
2 | 2 |
|
3 | | -Whenever changes to the [InnerSource Patterns][InnerSourcePatterns] GitHub repository are made, a new version of our InnerSource Patterns book is published at [patterns.innersourcecommons.org][book_production]. |
| 3 | +Whenever changes to the [InnerSource Patterns GitHub repository][InnerSourcePatterns] are made, a new version of the InnerSource Patterns book is published at [patterns.innersourcecommons.org][book_production]. |
4 | 4 |
|
5 | 5 | ## Where is the book published? |
6 | 6 |
|
7 | | -The most up-to-date version of the book is available for readers at [patterns.innersourcecommons.org][book_production]. |
| 7 | +The latest version of the book is available for readers at [patterns.innersourcecommons.org][book_production]. |
8 | 8 |
|
9 | | -We also have a [Staging version][book_staging], used by the editors/producers of the book for testing purposes. If you want to make any structural changes to the book, please send a PR to merge your changes into the `book-staging` branch. That way we can test your changes on the Staging version first, before they go live. |
| 9 | +We also have a [Staging version][book_staging], used by the editors/producers of the book for testing purposes. If you want to make structural changes to the book, please contact us via a GitHub issue first. |
10 | 10 |
|
11 | 11 | ## Which patterns are published? |
12 | 12 |
|
13 | | -The book contains patterns of maturity **Structured** (Level 2) or **Validated** (Level 3). **Initial** (Level 1) patterns are not published in the book, because those are still subject to a lot of change, and have likely not even proven to work yet. For more on these maturity levels see the [Contributor Handbook](../meta/contributor-handbook.md). |
| 13 | +The book contains patterns of maturity **Structured** (Level 2) or **Validated** (Level 3). |
14 | 14 |
|
15 | | -## How does it work? |
| 15 | +**Initial** (Level 1) patterns are not published in the book. Those are still subject to a lot of change, and have likely not even proven to work yet. For more on these maturity levels see the [Contributor Handbook](../meta/contributor-handbook.md). |
| 16 | + |
| 17 | +## How does it work technically? |
| 18 | + |
| 19 | +We use the [gitbook.com](https://www.gitbook.com) service to host our book. |
16 | 20 |
|
17 | 21 | The `/book` folder contains generator scripts and extra content required to create the gitbook. |
18 | 22 |
|
19 | 23 | - `.github/workflows/book.yml` - A GitHub Action that triggers scripts to generate the book. |
20 | | -- `/book/scripts/generate_toc.rb` - This script generates the table of contents (ToC) for the book. It takes patterns of maturity **Structured** and **Validated**, extracts title and patlet, and injects this info into `/book/en/toc_template.md`. The output is written to `/book/en/toc.md`. The ToC is what you see on the left-hand-side menu in the gitbook. |
| 24 | +- `/book/scripts/generate_toc.rb` - Generates the table of contents (ToC) for the book. It takes patterns of maturity **Structured** and **Validated**, extracts title and patlet, and injects this info into `/book/en/toc_template.md`. The output is written to `/book/en/toc.md`. The ToC is what you see on the left-hand-side menu in the gitbook. |
21 | 25 | - `/book/en/.gitbook.yaml` - Holds basic configuration for the gitbook service. This file is copied to the root of the repo, if the English book is generated. |
22 | 26 | - `/book/en/introduction.md` - The introduction to our book. This is what the reader sees first when they open the book. *Note:* The current content is based on [README.md](../README.md). |
23 | | -- `/book/en/contribute.md` - Information about how to contribute to this book. |
24 | | -- `/book/en/explore-patterns.md` - Show the mind map of all patterns. Allows readers to link to the mind map directly. |
| 27 | +- `/book/en/contribute.md` - Explains how to contribute to this book. |
| 28 | +- `/book/en/explore-patterns.md` - Shows the mind map of all patterns. Allows readers to link to the mind map directly. |
25 | 29 | - patterns content: |
26 | 30 | - The English patterns are in `/patterns` |
27 | 31 | - The translated patterns (e.g. for Japanese) are in `/translation/japanese` |
28 | 32 |
|
29 | 33 | The book is generated in multiple languages. |
30 | 34 |
|
31 | | -The descriptions above are for the English book. You find the language specific content in `/book/en`. |
| 35 | +The descriptions above are for the English book. You find the English content in `/book/en`. |
32 | 36 |
|
33 | 37 | For other languages (e.g. for Japanese), the content is mirrored and translated to folders like `/book/jp`. |
34 | 38 |
|
| 39 | +For more on the translation process see [these translation instructions](../translation/README.md). |
| 40 | + |
35 | 41 | ### Triggering the book generation |
36 | 42 |
|
37 | 43 | The book is generated in multiple languages. |
|
0 commit comments