Skip to content

Commit 552524c

Browse files
authored
Shortening some pattern titles to make for nicer links (#239)
Shortening some pattern titles to make for nicer links in the book. Moving the longer titles to the Alias section where that seemed useful.
1 parent 6f23686 commit 552524c

File tree

6 files changed

+26
-14
lines changed

6 files changed

+26
-14
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The below lists all known patterns. They are grouped into three [maturity levels
3737
* [Praise Participants](patterns/2-structured/praise-participants.md) - *Thank contributors effectively to engender further engagement from them and to encourage others to contribute*
3838
* [Repository Activity Score](patterns/2-structured/repository-activity-score.md) - *The repository activity score is a numeric value that represents the (GitHub) activity of an InnerSource project.*
3939
* [Review Committee](patterns/2-structured/review-committee.md) - *A formal review committee is setup within an org to "officiate" particular inner source projects with resources, etc.*
40-
* [Service vs. library: It's inner source, not inner deployment](patterns/2-structured/service-vs-library.md) - *Teams in a DevOps environment may be reluctant to work across team boundaries on common code bases due to ambiguity over who will be responsible for responding to service downtime. The solution is to realize that often it's
40+
* [Service vs. Library](patterns/2-structured/service-vs-library.md) - *Teams in a DevOps environment may be reluctant to work across team boundaries on common code bases due to ambiguity over who will be responsible for responding to service downtime. The solution is to realize that often it's
4141
possible to either deploy the same service in independent environments with separate escalation chains in the event of service downtime or factor a lot of shared code out into one library and collaborate on that.*
4242
* [Trusted Committer](patterns/2-structured/trusted-committer.md) - *Many inner-source projects will find themselves in a situation where they consistently receive feedback, features, and bug-fixes from contributors. In these situations project maintainers seek ways to recognize and reward the work of the contributor above and beyond single contributions.*
4343

@@ -50,9 +50,9 @@ possible to either deploy the same service in independent environments with sepa
5050
* [Open Source Trumps InnerSource](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/46) - *People find the InnerSource project but, after all things are considered, even if the InnerSource component meets their needs, they still go with the open source component.*
5151
* [Start as Experiment](patterns/2-structured/start-as-experiment.md) - *An inner source initiative is considered but not started, because management is unsure about its outcome and therefore unwilling to commit to the investment.*
5252
* [Include Product Owners](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/71) - *Key Performance Indicators (KPIs) for Product Owners are primarily product focused, and don't consider areas such as collaborative development. This results in a lower level of engagement with inner source projects.*
53-
* [Provide standard base documentation through a README](patterns/2-structured/project-setup/base-documentation.md) - *New contributors to an InnerSource project have a hard time figuring out who maintains the project, what to work on, and how to contribute. Providing documentation in standard files like README.md/CONTRIBUTING.md enables a self service process for new contributors, so that they can find the answers to the most common questions on their own.*
54-
* [Issue tracker use cases](patterns/2-structured/project-setup/issue-tracker.md) - *The InnerSource host team fails to make not only plans and progress but also context for changes transparent. This is solved by increasing the use cases for the project issue tracker to also serve brainstorming, implementation discussion, and feature design.*
55-
* [Communication tooling](patterns/2-structured/project-setup/communication-tooling.md) - *An InnerSource project is being used outside the original development team but users are having trouble getting help and getting in touch with the project team. The idea is to setup and document standard communication tooling that allows for discussions to become visible, archived and searchable.*
53+
* [Standard Base Documentation](patterns/2-structured/project-setup/base-documentation.md) - *New contributors to an InnerSource project have a hard time figuring out who maintains the project, what to work on, and how to contribute. Providing documentation in standard files like README.md/CONTRIBUTING.md enables a self service process for new contributors, so that they can find the answers to the most common questions on their own.*
54+
* [Issue Tracker Use Cases](patterns/2-structured/project-setup/issue-tracker.md) - *The InnerSource host team fails to make not only plans and progress but also context for changes transparent. This is solved by increasing the use cases for the project issue tracker to also serve brainstorming, implementation discussion, and feature design.*
55+
* [Communication Tooling](patterns/2-structured/project-setup/communication-tooling.md) - *An InnerSource project is being used outside the original development team but users are having trouble getting help and getting in touch with the project team. The idea is to setup and document standard communication tooling that allows for discussions to become visible, archived and searchable.*
5656

5757
### Maturity Level 1: Initial
5858

patterns/2-structured/maturity-model.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Title
22

3-
Maturity model: Learn about InnerSource best practices
3+
Maturity Model
44

55
## Patlet
66

@@ -225,6 +225,10 @@ long term.
225225

226226
## Acknowledgements
227227

228+
## Alias
229+
230+
Maturity model: Learn about InnerSource best practices
231+
228232
## Status
229233

230234
Drafted in September 2019

patterns/2-structured/project-setup/base-documentation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Title
22

3-
Provide standard base documentation through a README
3+
Standard Base Documentation
44

55
## Patlet
66

@@ -152,6 +152,10 @@ Europace AG, Paypal Inc.
152152

153153
## Acknowledgements
154154

155+
## Alias
156+
157+
Provide standard base documentation through a README
158+
155159

156160
## Status
157161

patterns/2-structured/project-setup/communication-tooling.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Title
22

3-
Communication tooling
3+
Communication Tooling
44

55
## Patlet
66

@@ -65,21 +65,21 @@ personally back to official communication channels.
6565

6666
## Resulting Context
6767

68-
Setting up and consistently using official asynchronous communication channels
69-
helps create a base level of passive documentation that can be referenced again
68+
Setting up and consistently using official asynchronous communication channels
69+
helps create a base level of passive documentation that can be referenced again
7070
when similar questions come up again.
7171

7272
With communication happening in the open others can easily follow project
73-
progress and get active contributing. Others lurking and reading lowers the
73+
progress and get active contributing. Others lurking and reading lowers the
7474
barrier to get involved raising the likelihood of receiving contributions.
7575

7676
With questions being answered in public more people can add their perspective
77-
leading to a complete picture - this includes not only host team members,
77+
leading to a complete picture - this includes not only host team members,
7878
but also users of the project.
7979

8080
Keeping communication in asynchronous channels allows for participants on
8181
different schedules - either due to different time zones or due to different
82-
routines, meeting schedules, team routines - to meaningfully contribute to
82+
routines, meeting schedules, team routines - to meaningfully contribute to
8383
the project.
8484

8585
Answering questions in those channels means that not only other team members

patterns/2-structured/project-setup/issue-tracker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Title
22

3-
Issue tracker use cases
3+
Issue Tracker Use Cases
44

55
## Patlet
66

patterns/2-structured/service-vs-library.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Title
2-
Service vs. library: It's inner source, not inner deployment
2+
Service vs. Library
33

44
## Patlet
55
Teams in a DevOps environment may be reluctant to work across team boundaries on
@@ -88,3 +88,7 @@ Isabel Drost-Fromm
8888
## Acknowledgements
8989

9090
Thank you Tobias Gesellchen for review internal to Europace AG.
91+
92+
## Alias
93+
94+
Service vs. library: It's inner source, not inner deployment

0 commit comments

Comments
 (0)