You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 22bcff8
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: book/README.md
+15-8Lines changed: 15 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,23 +16,30 @@ The book contains patterns of maturity **Structured** (Level 2) or **Validated**
16
16
17
17
The `/book` folder contains generator scripts and extra content required to create the gitbook.
18
18
19
-
The below outlines the function of the main files used in the gitbook generation:
20
-
21
-
-`.github/workflows/book.yml` - A GitHub Action that triggers all scripts required to generate the book.
19
+
-`.github/workflows/book.yml` - A GitHub Action that triggers scripts to generate the book.
22
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.
23
21
-`/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.
24
-
-`/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). We may need to modify this content even further, to address the readers of the book more specifically, rather than the readers of our GitHub repository.
22
+
-`/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).
25
23
-`/book/en/contribute.md` - Information about how to contribute to this book.
26
-
-`/book/en/explore-patterns.md` - A page in the book that highlights the mind map of all patterns.
24
+
-`/book/en/explore-patterns.md` - Show the mind map of all patterns. Allows readers to link to the mind map directly.
25
+
- patterns content:
26
+
- The English patterns are in `/patterns`
27
+
- The translated patterns (e.g. for Japanese) are in `/translation/japanese`
28
+
29
+
The book is generated in multiple languages.
27
30
28
-
The book is generated in multiple languages. The extra content for each language is located in language-specific folders such as `/book/en` and `/book/jp`.
31
+
The descriptions above are for the English book. You find the language specific content in `/book/en`.
32
+
33
+
For other languages (e.g. for Japanese), the content is mirrored and translated to folders like `/book/jp`.
29
34
30
35
### Triggering the book generation
31
36
32
-
Depending on which branch a change is merged into, a different book is generated:
37
+
The book is generated in multiple languages.
38
+
39
+
Depending on which **branch** a change is merged into, a different book is generated:
33
40
34
41
* changes merged to `main` branch: triggers the book generation for the **English** book.
35
-
* changes merged to `translation-japanese` branch: triggers the book generation for the **Japanese** book.
42
+
* changes merged to `book-jp` branch: triggers the book generation for the **Japanese** book.
0 commit comments