Skip to content

Commit 47937fa

Browse files
committed
Improving the docs of the book generation.
Also linking to the translation documentation.
1 parent 909b786 commit 47937fa

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

‎book/README.md‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
11
# How to generate the InnerSource Patterns gitbook
22

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].
44

55
## Where is the book published?
66

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].
88

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.
1010

1111
## Which patterns are published?
1212

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).
1414

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.
1620

1721
The `/book` folder contains generator scripts and extra content required to create the gitbook.
1822

1923
- `.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.
2125
- `/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.
2226
- `/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.
2529
- patterns content:
2630
- The English patterns are in `/patterns`
2731
- The translated patterns (e.g. for Japanese) are in `/translation/japanese`
2832

2933
The book is generated in multiple languages.
3034

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`.
3236

3337
For other languages (e.g. for Japanese), the content is mirrored and translated to folders like `/book/jp`.
3438

39+
For more on the translation process see [these translation instructions](../translation/README.md).
40+
3541
### Triggering the book generation
3642

3743
The book is generated in multiple languages.

0 commit comments

Comments
 (0)