Skip to content

Publishing patterns book in Chinese (zh) #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 67 commits into from
Jan 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
b354e81
Added Chinese translation of 30-day-warranty
WillemJiang Nov 30, 2022
9758faf
Try to fix the link check error
WillemJiang Nov 30, 2022
39b874e
Fixed the markdown link check error
WillemJiang Nov 30, 2022
b324522
Added the pattern files to the translation-cn directory
WillemJiang Dec 1, 2022
2a30b33
Removed the wrong copied the markdown file
WillemJiang Dec 5, 2022
9a240d1
Added draft of trusted-committer.md (#1)
WillemJiang Dec 6, 2022
d7c5a9a
Added the rfc template
WillemJiang Dec 6, 2022
2cc5048
Added the Chinese translation of README template (#2)
WillemJiang Dec 9, 2022
dc5c83b
Add the translation of service-vs-library (#3)
WillemJiang Dec 9, 2022
aa2125e
Committed the translation of core-team pattern (#4)
WillemJiang Dec 9, 2022
b4f3c8c
Added the translation of innersource license (#18)
WillemJiang Dec 9, 2022
863a46e
Added the translation of common-requirements (#6)
WillemJiang Dec 9, 2022
06254c4
Added the translation of communication-tool (#8)
WillemJiang Dec 9, 2022
ab5c176
Added the translation of issue-tracker (#7)
WillemJiang Dec 9, 2022
c1972cf
Update the innersource translation of innersource-license.md
WillemJiang Dec 9, 2022
7e34ebc
Clean up the translation of 30-day-warranty.md
WillemJiang Dec 9, 2022
ff2a08c
Clean up InnerSource term in the README-template
WillemJiang Dec 9, 2022
4e8546f
Added the translation of dedicated community leader (#11)
WillemJiang Dec 11, 2022
8a2f934
Added the translation of RFC (#9)
WillemJiang Dec 11, 2022
4de849d
Added the translation of innersource-portal (#17)
WillemJiang Dec 12, 2022
237a92b
Fixed the link issue
WillemJiang Dec 19, 2022
16214f1
Updated the translation of contributing template (#22)
WillemJiang Dec 19, 2022
166f775
Added the translation of repository-activity-score (#16)
WillemJiang Dec 19, 2022
6161528
Update the translation of rfc-template (#21)
WillemJiang Dec 19, 2022
b507499
Added the translation of review committee (#13)
WillemJiang Dec 21, 2022
78dbe25
Added the translation of crossteam project valuation (#12)
WillemJiang Dec 21, 2022
833c746
Added the translation of praise participant (#14)
WillemJiang Dec 21, 2022
b7ad23f
Added the translation of start as experiment (#10)
WillemJiang Dec 21, 2022
3a7e0d7
Added the Chinese translation of book
WillemJiang Dec 19, 2022
7f229a5
Added the Chinese book cover
WillemJiang Dec 21, 2022
4d1299e
Modify GHA to be able to publish Chinese patterns book
spier Dec 23, 2022
8464934
Added the translation of gig marketplace (#15)
WillemJiang Dec 26, 2022
2ece031
Update the logic for selecting the files based on the language for wi…
spier Dec 26, 2022
a249d9e
Make documentation more generic, to apply to other languages as well …
spier Dec 26, 2022
5b403bb
Added the Chinese transaltion of git book (#23)
WillemJiang Dec 28, 2022
0e33453
Update the translation of Maturity model (#20)
WillemJiang Dec 28, 2022
ec6bd6a
Added the translation of document-your-guiding-principles (#19)
WillemJiang Dec 28, 2022
71f6069
Clean up the format issue
WillemJiang Dec 28, 2022
35e9570
Update the translation of 30-day-warranty
WillemJiang Dec 29, 2022
7bc679a
Polished the document of innersource-portal
WillemJiang Dec 29, 2022
e7640f5
Clean up the Chinese translation documents
WillemJiang Dec 29, 2022
a34b7a4
Fixed the link broken errors of book/cn
WillemJiang Dec 29, 2022
e5738cd
Fixed the broken link error of Chinese translation
WillemJiang Dec 29, 2022
9f08b38
Tried to fix the broken link errors
WillemJiang Dec 29, 2022
98586c8
Merge remote-tracking branch 'chinese/translation-cn' into book-zh
spier Dec 29, 2022
1e064d4
Renaming folders from cn to zh
spier Dec 29, 2022
1e21092
Writing updated files for the book
spier Dec 29, 2022
f158498
Testing if this explains why the GHA does not pickup the majority of …
spier Dec 29, 2022
4b0d1c9
Writing updated files for the book
spier Dec 29, 2022
d88e7dd
Change back the name of all title sections to 'Title'. Otherwise the …
spier Dec 29, 2022
46e9334
Writing updated files for the book
spier Dec 29, 2022
14c61cf
Switch more paths from cn to zh
spier Dec 29, 2022
bb0ce67
Merge branch 'book-zh' of github.com:InnerSourceCommons/InnerSourcePa…
spier Dec 29, 2022
c635f70
Writing updated files for the book
spier Dec 29, 2022
09d0f4b
merged the recent changes from main branch.
WillemJiang Dec 30, 2022
49a95ba
Specify the language codes that we use more clearly.
spier Dec 30, 2022
28847ba
Added translation of base-documentation (#25)
WillemJiang Dec 31, 2022
72209b9
Add translation of contracted contributor pattern (#24)
WillemJiang Dec 31, 2022
0ec3abf
Updated book cover (reduzed size; larger font)
spier Jan 1, 2023
74333b9
Merge remote-tracking branch 'chinese/translation-cn' into book-zh
spier Jan 1, 2023
a21881a
Writing updated files for the book
spier Jan 1, 2023
4c6616b
Fix label for title sections (to fix TOC generation)
spier Jan 1, 2023
986744c
Writing updated files for the book
spier Jan 1, 2023
ea8d114
Added the date information of Chinese translation and reviewing (#516)
WillemJiang Jan 3, 2023
a3892da
Clean up the Chinese book (#517)
WillemJiang Jan 3, 2023
be91998
Fixed the formate issue of the Chinese translation (#518)
WillemJiang Jan 4, 2023
d4ff1cd
Fix broken link
spier Jan 4, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
root : ./

structure:
readme: book/en/introduction.md
summary: book/en/toc.md
readme: book/zh/introduction.md
summary: book/zh/toc.md
2 changes: 1 addition & 1 deletion .github/workflows/book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:

- name: Determine book language
run: |
[[ "$GITHUB_REF_NAME" =~ ^book-ja.*$ ]] && book_language="ja" || book_language="en"
[[ "$GITHUB_REF_NAME" =~ ^book-.*$ ]] && book_language=${GITHUB_REF_NAME:5:2} || book_language="en"
echo "BOOK_LANGUAGE=$book_language" >> $GITHUB_ENV

- name: Generate ToC
Expand Down
8 changes: 5 additions & 3 deletions book/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ The `/book` folder contains generator scripts and extra content required to crea
- `/book/en/explore-patterns.md` - Shows the mind map of all patterns. Allows readers to link to the mind map directly.
- patterns content:
- The English patterns are in `/patterns`
- The translated patterns (e.g. for Japanese) are in `/translation/ja`
- The translated patterns are in `/translation/<YOUR_LANGUAGE>`[^1]

The book is generated in multiple languages.

The descriptions above are for the English book. You find the English content in `/book/en`.

For other languages (e.g. for Japanese), the content is mirrored and translated to folders like `/book/ja`.
For other languages the content is mirrored and translated to folders like `/book/<YOUR_LANGUAGE>`[^1].

For more on the translation process see [these translation instructions](../translation/README.md).

Expand All @@ -45,7 +45,7 @@ The book is generated in multiple languages.
Depending on which **branch** a change is merged into, a different book is generated:

* changes merged to `main` branch: triggers the book generation for the **English** book.
* changes merged to `book-ja` branch: triggers the book generation for the **Japanese** book.
* changes merged to `book-<YOUR_LANGUAGE>`[^1] branch: triggers the book generation for the book in the given language e.g. `book-jp` for the **Japanese** book.

## Objectives of the book

Expand All @@ -64,3 +64,5 @@ There are a couple of good reasons to publish the InnerSource patterns as a gitb
[InnerSourcePatterns]: https://github.com/InnerSourceCommons/InnerSourcePatterns
[book_production]: https://patterns.innersourcecommons.org
[book_staging]: https://innersourcecommons.gitbook.io/innersource-patterns-staging/

[^1]: Replace `<YOUR_LANGUAGE>` with the [2-letter ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your language.
12 changes: 7 additions & 5 deletions book/scripts/generate_toc.rb
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,16 @@ def generate_patterns_overview(patterns)
puts "Generating ToC for language: #{BOOK_LANGUAGE}"

## Files to be used for the different languages
if (BOOK_LANGUAGE == "ja")
TOC_TEMPLATE_FILE = "../ja/toc_template.md"
TOC_FILE = "../ja/toc.md"
PATTERNS = Dir["../../translation/ja/patterns/*.md"]
else
## Note: the folder structure for the patterns is slightly different for 'en' than it is for the other languages,
## hence this slightly complicated logic here.
if (BOOK_LANGUAGE == "en")
TOC_TEMPLATE_FILE = "../en/toc_template.md"
TOC_FILE = "../en/toc.md"
PATTERNS = Dir["../../patterns/2-structured/*.md","../../patterns/2-structured/project-setup/*.md", "../../patterns/3-validated/*.md"]
else
TOC_TEMPLATE_FILE = "../#{BOOK_LANGUAGE}/toc_template.md"
TOC_FILE = "../#{BOOK_LANGUAGE}/toc.md"
PATTERNS = Dir["../../translation/#{BOOK_LANGUAGE}/patterns/*.md"]
end

# Generate list of patterns and sort them by name
Expand Down
5 changes: 5 additions & 0 deletions book/zh/.gitbook.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
root : ./

structure:
readme: book/zh/introduction.md
summary: book/zh/toc.md
36 changes: 36 additions & 0 deletions book/zh/contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 为本书做贡献

你想让这本书变得更好?那真是太棒了!

《内源模式》这本书本身就是一个[开源项目][repo],欢迎任何形式的贡献。没有什么是微不足道的!

不管你是想帮助我们修正语法/拼写,改进设计,还是根据你在工作场所的内源经验贡献全新的模式。我们喜欢所有这些(贡献)! :)

如果你以前从未为一个开源项目做出过贡献,请知道内源模式社区是一个由友好的人组成的团体,并且有一个安全的地方可以尝试这些贡献。

## 在你开始之前

内源模式和本书的源代码都保存在GitHub上的一个仓库中。因此,你需要一个GitHub用户账户来对本书进行编辑和提交建议。如果你还没有,请前往[github.com](https://github.com),免费创建一个账户。

## 贡献的不同方式

这里有几种你可以做出贡献的方式。

1. 修复你在本书中发现的拼写、格式或其他小问题
2. 改进现有模式的内容(例如,通过添加一个简短的描述,说明你是如何使用一个模式作为_已知实例的)。
3. 贡献一个新的模式,描述你如何在你的组织中克服内源相关的挑战。

对于上述(1)和(2),你可以简单地点击本书每页顶部的**Edit on GitHub**链接。这将使你直接进入我们GitHub仓库中的相应文件,在那里你可以提出你的修改意见。

对于(3),你需要克隆[内源模式][repo]资源库,并将你建议的模式添加到一个新文件中。当对本书做出这种较大的贡献时,请查看我们的[CONTRIBUTING.md](../../CONTRIBUTING.md)和我们的[贡献者手册](../../meta/contributor-handbook.md)。

## 贡献的许可

本资源库的内容以[CC-BY-SA-4.0](../../LICENSE.txt)授权。通过向这个资源库贡献,你授予我们(以及其他所有人)根据该许可使用你的贡献的权利。

[repo]: https://github.com/InnerSourceCommons/InnerSourcePatterns

## 翻译校对

* **2022-12-21** 翻译[姜宁](https://github.com/willemjiang)
* **2022-12-28** 校对[龙文选](https://github.com/hncslwx)
24 changes: 24 additions & 0 deletions book/zh/explore-patterns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# 探索模式

越来越多的模式是由InnerSource Commons社区贡献给本书的。这真是太棒了!

现在,如何让读者更容易发现那些能在特定情况下帮助他们的模式?

为此,我们提供了这个思维导图。它**根据内源项目的不同阶段对模式进行了分类**,以及在各个阶段可能出现的挑战。

![内源模式的思维导图](../../pattern-categorization/innersource-program-mind-map.png)

## 改进这个思维导图

如果你注意到这个思维导图中的任何问题,请[打开一个问题](https://github.com/InnerSourceCommons/InnerSourcePatterns/issues),描述这个问题以及应该做的修正。

此外,如果你有其他想法来提高这些模式的可发现性,或者想让这个思维导图变得更好,请查看我们的[模式归类](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/pattern-categorization/README.md)方法的文档,也可以查看如何[为本书做贡献](contribute.md)。

## 参考文献

像这样对模式进行分类的想法大致是基于Tim Yao、Bob Hanmer和Padma Sudarsan(2018)在[有关内源模式语言的思考](https://drive.google.com/file/d/13AY8glCOdpLOVuz7cVD6QOB8d2xbHCS1/view)中的描述。具体内容见该幻灯片中的第15张幻灯片。

## 翻译校对

* **2022-12-21** 翻译[姜宁](https://github.com/willemjiang)
* **2022-12-28** 校对[龙文选](https://github.com/hncslwx)
Binary file added book/zh/innersource-patterns-book-cover.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 70 additions & 0 deletions book/zh/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# 介绍

![内源模式](innersource-patterns-book-cover.jpg)

{% hint style="info" %}
你正在阅读《内源模式》的早期版本,可能仍然会发现破碎的链接、拼写错误或其他错误。
请帮助我们解决这些问题,以便尽可能制作出最好的图书:)。了解如何[为这本书做贡献](contribute.md).
{% endhint %}

欢迎来到**内源模式**。

这本书包含了内源的最佳实践,并以特定的格式进行编纂,以便于理解、评估和在你的环境中应用它们。我们称这种格式为**模式**。

[InnerSource Commons](http://innersourcecommons.org)多年来收集了这些模式,在本书中发布了最成熟的模式,社区成员对每个模式进行了评审,至少有一个已知的模式使用实例。

在这篇介绍中,我们解释了[内源是什么](#内源是什么),[内源模式是什么](#内源模式是什么),以及[如何在你的组织中使用这些模式](#如何使用这些模式) 。

如果你已经在你的公司使用内源,并想把你的经验贡献给本书,我们很乐意[欢迎你的贡献](contribute.md)!

## 内源是什么?

我们将内源定义为。

> 在一个组织的范围内使用开源的原则和实践进行软件开发。

内源从开发开源软件中吸取经验教训,并将其应用于企业内部开发软件的方式。由于开发人员已经习惯于在世界级的开源软件上工作,人们强烈希望将这些实践带回防火墙内,并将其应用于公司可能不愿意公开发布的软件。

对于那些主要构建闭源软件的公司来说,内源可以成为一个很好的工具,帮助打破孤岛,鼓励和扩大内部协作,加速新工程师的入职成长,并找到机会将软件贡献给开源世界。

## 内源模式是什么?

模式是一种描述在某一背景下对某一问题的可重复的、经过验证的解决方案的方式。模式遵循一种简单的形式,在实施解决方案的过程中,协助你了解问题的限制,了解你需要平衡的限制条件,以及由此产生的结果--应用解决方案所创造的情况。

模式可以为InnerSource Commons的参与者提供一种简明的信息分享方式,改善内源的实践。模式分为标题、问题陈述、背景、约束和解决方案,作为其主要部分。

* ["什么是模式?"Youtube视频](http://bit.ly/innersource_patterns_videos) - 观看一组2-5分钟的Youtube视频,解释内源模式。
* [模式讨论网络研讨会](https://youtu.be/i-0IVhfRVFU) - 我们在2017-03-16举行了一次网络研讨会,现场讨论一个甜甜圈模式(进入24:30的讨论)。这是对我们所遵循的评审过程的说明。也可参见[2017年6月1日O'Reilly网络研讨会上的内源模式](http://www.oreilly.com/pub/e/3884) 。
* [模式模板](../../meta/pattern-template.md) --查看一个内源模式的骨架,了解新模式的内容!
* [内源模式介绍(2016年秋季峰会演讲)](https://drive.google.com/open?id=0B7_9iQb93uBQbnlkdHNuUGhpTXc) - *Tim Yao和Padma Sudarsan* (PDF)。详细的模式背景和例子 -- 详细了解为什么以及如何与我们的模式互动。也可参见[内源模式介绍(2017年秋季峰会)](https://drive.google.com/open?id=0B7_9iQb93uBQWmYwMFpyaGh4OFU) *Tim Yao和Bob Hanmer* (PDF)。

## 如何使用这些模式?

模式的使用必须经过深思熟虑。它们不能被不加区分地应用。在大多数情况下,你需要根据你的情况来调整给定的解决方案;但模式中给出的信息,定义了背景(不可移动的约束)和力量(可以改变和相互平衡的约束),应该有助于你应用这些模式。请注意,你还需要确定是否有额外的约束(公司背景和公司力量)适用于你的特定公司/组织,必须添加到模式中(作为一种过滤器)。这些额外的制约因素可能需要额外的解决步骤来应用。

模式的形式对于描述成熟的解决方案是很有用的,但它也可以用于*脑力激荡的新解决方案*,创建哪些尚未建立的模式。这是因为模式的解剖提供了一个以结构化方式思考问题的框架。你也可以创建一个*甜甜圈模式*(填写问题、背景、约束和结果等字段,但在解决方案留空),作为向InnerSource Commons社区寻求帮助的一种方式(找到一个成熟的解决方案或做一次集思广益的尝试)。

## 如何贡献?

请参考: [为这本书做贡献](./contribute.md)

## 致谢

本书是世界各地无数[开源贡献者](https://github.com/InnerSourceCommons/InnerSourcePatterns/graphs/contributors)多年工作的成果。他们愿意公开分享他们在公司所面临的挑战,以及内源如何帮助他们解决这些挑战,使本书成为其他人在内源旅程中的宝贵资源。

我们要特别提到内源模式工作组。他们孕育了内源模式的质量,并帮助其他人作出贡献。最后,他们还将一些可用的模式汇编成了这本书。

本书的标题图片由[Sebastian Spier](https://spier.hu)创作,并改编自[Tony Hisgett - Alhambra 6](https://www.flickr.com/photos/hisgett/29345405788/)的图片,可根据[CC BY 2.0](https://creativecommons.org/licenses/by/2.0/)获得。

**感谢所有的贡献者! 并祝内源日快乐 :)**

## Licensing

![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)

InnerSourcePatterns by [InnerSourceCommons.org](http://innersourcecommons.org) is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/) License.

## 翻译校对

* **2022-12-21** 翻译[姜宁](https://github.com/willemjiang)
* **2022-12-28** 校对[龙文选](https://github.com/hncslwx)
Loading