Skip to content

Commit 9f9f1b6

Browse files
authored
Merge pull request #16 from asrarqazi/Fixed-typos-for-InnerSource
Fixed all typos for InnerSource
2 parents d5028cb + a3c4a98 commit 9f9f1b6

File tree

12 files changed

+101
-100
lines changed

12 files changed

+101
-100
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Managing Inner Source Projects book
1+
# Managing InnerSource Projects book
22

33
<img src="managing-innersource-projects-cover.jpg" title="Managing InnerSource Projects">
44

55
This book is intended to bring, from a managerial perspective, the several aspects needed
6-
when introducing inner source methodologies into enterprises.
6+
when introducing InnerSource methodologies into enterprises.
77

88
This book is a work in progress process where anyone is more than welcome to contribute
99
in any possible way. Ideas, comments, typos, full paragraphs or sections would be
@@ -18,26 +18,27 @@ You can find more information about the process in the [contributing section](ht
1818

1919
Bitergia, as neutral actor in the software development analytics field aims at
2020
sharing the knowledge acquire during the last years. This book is currently focused on its main areas of expertise such as the usual metrics and KPI's to use,
21-
the methodology, the metrics strategy around your general inner source strategy
22-
or the infrastructure needed to have a successful inner source
21+
the methodology, the metrics strategy around your general InnerSource strategy
22+
or the infrastructure needed to have a successful InnerSource
2323
journey within your company.
2424

25-
This book is open to anyone interested in inner source, either you are
26-
applying this and you want to share your use case or you have successfully
27-
applied inner source in your internal software development process.
25+
This book is open to anyone interested in InnerSource, either you are
26+
applying this and you want to share your use case or you have successfully
27+
applied InnerSource in your internal software development process.
28+
2829

2930

3031

3132
## References
3233

33-
For further reading, we encourage you to participate in the [Inner Source Commons site](https://paypal.github.io/InnerSourceCommons/)
34+
For further reading, we encourage you to participate in the [InnerSource Commons site](https://paypal.github.io/InnerSourceCommons/)
3435
funded by PayPal where dozens of companies are already sharing experiences and working to
3536
understand all of this. It is a great place to understand how others are facing this
3637
new methodology as we are all learning from this incipient process.
3738

3839
And finally, if you're interested in participating from a survey perspective and share
3940
your insights about this within your organization, please have a look at the
40-
[Inner Source Survey](https://paypal.github.io/InnerSourceCommons/assets/files/InnerSourceCommonsSurvey2016.pdf).
41+
[InnerSource Survey](https://paypal.github.io/InnerSourceCommons/assets/files/InnerSourceCommonsSurvey2016.pdf).
4142

4243

4344
## Acknowledgements

infrastructure/infrastructure.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Introduction
22

3-
Infrastructure is one of the key aspects when dealing with inner source.
3+
Infrastructure is one of the key aspects when dealing with InnerSource.
44
This provides the tools necessary to develop and communicate across
55
the development teams.
66

77
Developers, middle management and C-level are all part of this process.
88
All of these groups are part of the mindset change to be part of a more open
99
software development process. And any of those should accept the new rules to play.
1010

11-
As inner source aims at bringing some of the principles when developing
12-
in open source communities, inner source communities needs a cultural
11+
As InnerSource aims at bringing some of the principles when developing
12+
in open source communities, InnerSource communities needs a cultural
1313
change where open communication and transparency in the decision making
1414
process are vital.
1515

@@ -48,7 +48,7 @@ and mined.
4848
accessible by anyone within the organization. Any person related in somehow
4949
to the development process should have access to this. This is helpful to
5050
build confidence across developers and lower the barriers to anyone willing
51-
to contribute to the inner sourced projects. Any contribution is welcome and
51+
to contribute to the InnerSourced projects. Any contribution is welcome and
5252
being open to any type of contributor is necessary.
5353

5454
* **Transparency**. This is focused on the authorship of the several contributions.
@@ -60,14 +60,14 @@ and mined.
6060
such communities. As there are contributions beyond the code, the ownership of
6161
the contributions should help to understand other types of contributions. From
6262
documentation to mentorship or helping others in the forums are activities of
63-
interest in inner source communities.
63+
interest in InnerSource communities.
6464

6565
* **Archivable**. Any tool should provide an archive of previous actions. This will
6666
help when talking about specific pieces of code, previous technical discussions
6767
in the communication channels or decisions made during the design summits. This
6868
should help for referencing purposes.
6969

70-
* **Searchable**. As more and more projects will be added to the inner source process,
70+
* **Searchable**. As more and more projects will be added to the InnerSource process,
7171
the amount of repositories of information will grow in the same way. It is
7272
important to have searching capabilities within the platform. This will help
7373
to reuse and discover projects and contributors useful for our own purposes.
@@ -83,7 +83,7 @@ and mined.
8383
any other non-desired situation.
8484

8585
As detailed in the metrics chapter, data play a key
86-
role in the deployment of the inner source methodology. This will help
86+
role in the deployment of the InnerSource methodology. This will help
8787
to understand where the whole process is going and make decisions when
8888
necessary to follow the right direction. For this, tools that allow
8989
to retrieve information through an API (e.g.: GitHub API) or thanks to
@@ -106,14 +106,14 @@ The first one focuses on the needed and
106106
basic infrastructure when starting from scratch an open source project. While
107107
the latter is focused on how to support specific workflows with tools. And
108108
both are great approaches when dealing with open source projects and partially
109-
useful when dealing with inner source projects.
109+
useful when dealing with InnerSource projects.
110110

111111
As Jono states in his book "_To select the right tools for the job, we need
112112
first to understand what we are trying to achieve. We need to know what our
113113
**workflow** is_".
114114

115115
The following section focuses on the infrastructure needs when starting an
116-
inner source project. In the basics there are not main differences from the
116+
InnerSource project. In the basics there are not main differences from the
117117
key aspects point of view. However we have to deal with existing, internal
118118
and in some cases access-restricted infrastructure and check if that infrastructure is enough
119119
for our new purposes and goals when inner-sourcing.
@@ -125,7 +125,7 @@ are available that fit with our key-aspects requirements.
125125

126126
# Basic Infrastructure
127127

128-
As inner source is mainly about cultural change, we need to have an easy-access
128+
As InnerSource is mainly about cultural change, we need to have an easy-access
129129
and low barrier tools. The easier to use, the more developers that will try
130130
in first place to work with other business units and inner-sourced projects.
131131

@@ -134,7 +134,7 @@ other areas where developers can start to contribute. From documentation and
134134
mere typos in the collaborative wiki to design meetings and even review
135135
activities in projects of your interest or asking for feature requests. There
136136
is a myriad of potential actions that anyone within the organization can help
137-
with. And the goal of inner source is to foster those actions as much as possible
137+
with. And the goal of InnerSource is to foster those actions as much as possible
138138
letting developers know that those actions are really much appreciated.
139139

140140
The infrastructure is thus divided into three main areas:
@@ -164,14 +164,14 @@ communities. More advanced options could be the use of [Slack](https://slack.com
164164
[Mattermost](https://mattermost.com) if the organization prefers to use
165165
open source and in house SaaS deployments.
166166

167-
* In third place the monitoring infrastructure is key when applying inner source and
167+
* In third place the monitoring infrastructure is key when applying InnerSource and
168168
in general when bringing a new methodology to organizations. This is one of the
169169
main differences with open source communities. They are open by default and basically
170170
follow the detailed key aspects. However, infrastructure to measure process advances
171171
have not been one of the main goals in the case of open source communities.
172172
Basically they are using a successful development methodology, each of them
173173
with their own peculiarities, but open by default.
174-
Inner source needs of this type of infrastructure as managers and developers
174+
InnerSource needs of this type of infrastructure as managers and developers
175175
need feedback about their performance. A change in the software development
176176
process of large organizations, a cultural change and the community building
177177
process needs a large set of actions and those actions should have the
@@ -186,7 +186,7 @@ similar to the one depicted in the following picture. If this process
186186
is familiar to you is because this is based on the [OpenStack software development
187187
process](https://docs.openstack.org/infra/manual/developers.html) as detailed in their wiki site.
188188
I have copied the workflow as this contains the basic pieces also needed for
189-
inner source. Other communities use a similar approach, although I did not find
189+
InnerSource. Other communities use a similar approach, although I did not find
190190
a nice picture! Sorry folks!. In addition to this, this is a new figure as
191191
I wanted to have it independent of the infrastructure. OpenStack uses
192192
Git, Gerrit and other tooling for this process, but others are also possible.
@@ -237,7 +237,7 @@ system before proceeding with the code review process. They would be sure
237237
that this works prior any effort from them.
238238

239239
* ** Ticketing system **: tickets are useful to attract community to an
240-
inner source project. This helps in two specific ways: transparency of the
240+
InnerSource project. This helps in two specific ways: transparency of the
241241
development process, raising issues and having a roadmap of the issues
242242
to be closed. And in second place, to provide a platform for newcomers and
243243
users to detail their needs. Tickets are helpful to bring community in inner
@@ -262,7 +262,7 @@ the documentation also covers information as general as the mission and
262262
the type of things that the piece of code does and the things that this does
263263
not do.
264264

265-
* ** Collaborative design platform **: inner source in large organizations
265+
* ** Collaborative design platform **: InnerSource in large organizations
266266
is a synonym of geographically distributed teams. Face to face meetings are
267267
hard to have in this type of organizations, but there should exist infrastructure
268268
to bridge those difficulties. Requirements specifications, technical decisions,
@@ -277,7 +277,7 @@ by others within the organization.
277277

278278
## Communication channels infrastructure
279279

280-
Inner source is about cultural change. And that cultural change is based on
280+
InnerSource is about cultural change. And that cultural change is based on
281281
transparency and meritocracy. Communication channels should be open within
282282
the organization, and anyone is allowed to post to them.
283283

@@ -319,7 +319,7 @@ and such data source should provide a way to mine this. This will provide
319319
raw data information that should be later parsed and treated to be useful.
320320

321321
There is extra information in the metrics chapter, but in brief, any organization
322-
applying inner source, or any other new methodology, should have a way to
322+
applying InnerSource, or any other new methodology, should have a way to
323323
check how that new process is performing when compared to the old way.
324324

325325
This monitoring infrastructure should also have as outcomes several ways of
@@ -361,13 +361,13 @@ also KPIs or static documents to be shared with third parties.
361361
# Comparing how inner-sourced your infrastructure is
362362

363363
Just detailing the infrastructure needed within an organization to effectively
364-
apply inner source would be simplistic. This section aims at listing the
364+
apply InnerSource would be simplistic. This section aims at listing the
365365
questions you need to ask to your infrastructure team to check if
366366
that internal and well known infrastructure is able to be part of the
367-
inner source process.
367+
InnerSource process.
368368

369369
The goal of this section is to compare the internal infrastructure used within
370-
an organization and check how close this is to an ideal inner source toolchain.
370+
an organization and check how close this is to an ideal InnerSource toolchain.
371371
As detail, in the software development process, it is necessary the use of
372372
specific tools such as the versioning system, code review process, ticketing
373373
system, continuous integration, documentation storage and collaborative

introduction/framework.md

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

3-
By adopting inner source methodology and principles, organizations get:
3+
By adopting InnerSource methodology and principles, organizations get:
44

55
- Effective resources management, with better code/knowledge reuse
66
and cost sharing accross the different units
@@ -28,7 +28,7 @@ that support them defining:
2828

2929
- metrics and KPIs
3030

31-
Let's introduce the *inner source framework*.
31+
Let's introduce the *InnerSource framework*.
3232

3333
## Governance
3434

@@ -69,7 +69,7 @@ Usually the governance model is a written document containing:
6969

7070
## Technical infrastructure
7171

72-
By technical infrastructure we describe the tools used by inner source
72+
By technical infrastructure we describe the tools used by InnerSource
7373
developers for their daily work. Usually, this tools cover:
7474

7575
- Source code management systems
@@ -88,28 +88,28 @@ developers for their daily work. Usually, this tools cover:
8888

8989
Creating an engaged community is one of the key points for
9090
open source projects success and sustainability. Same
91-
principle applies for inner source projects.
91+
principle applies for InnerSource projects.
9292

9393
Managing a community is different from traditional development teams
9494
management, so project managers need to adapt their skills
9595
to the new scenario.
9696

9797
Open source communities are very flat organizations where
9898
leadership is usually more important than formal power.
99-
Companies adopting inner source need to adapt their
99+
Companies adopting InnerSource need to adapt their
100100
organizational structure to a flatter one.
101101

102102
## Financial support
103103

104-
In a perfect inner source scenario, and based in David Pink quote
104+
In a perfect InnerSource scenario, and based in David Pink quote
105105
you should pay enough “to take the issue of money off the table.”
106106

107107
But we usually don't live in perfect worlds, and there are several
108-
scenarios where financial support for inner projects are critical:
108+
scenarios where financial support for InnerSource projects are critical:
109109

110110
- payment in different geographical regions
111111

112-
- employees working in a mix of inner and non-inner source projects
112+
- employees working in a mix of InnerSource and non-InnerSource projects
113113

114114
- cost sharing between different business units with their own budget
115115

@@ -135,14 +135,14 @@ with the teams, and what the want to achieve.
135135
>is the first step toward community.” – Henry Lewis Gates (professor at
136136
>Harvard)
137137
138-
Open measurment gives a lot of benefits for our inner source community:
138+
Open measurment gives a lot of benefits for our InnerSource community:
139139

140140
- awareness, it allows us to understand who we are, what we are doing, etc.
141141

142142
- governance check, monitoring policies implementatio
143143

144144
- transparency, as trust generator for third parties and fairness
145-
for our inner community
145+
for our InnerSource community
146146

147147

148148
[^1]: http://oss-watch.ac.uk/resources/governancemodels

introduction/introduction.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,16 @@ teamwork.”
3232

3333
Since the collaboration methodologies used in OSS projects are providing
3434
high quality innovative technology thanks to engaged development communities,
35-
why not applying same methodologies inside your company? That's inner source!
35+
why not applying same methodologies inside your company? That's InnerSource!
3636

37-
If you haven't decided yet to apply inner source in your company, we recommend you
37+
If you haven't decided yet to apply InnerSource in your company, we recommend you
3838
start reading "Getting Started with InnerSource"[^3] by Andy Oran. After that, or if
39-
you have already decided to start the inner source path, this book will give you better
40-
understanding of inner source scenarios, framework and management skills.
39+
you have already decided to start the InnerSource path, this book will give you better
40+
understanding of InnerSource scenarios, framework and management skills.
4141

42-
## Inner source principles
42+
## InnerSource principles
4343

44-
Inner source software development takes its principles from the open source software
44+
InnerSource software development takes its principles from the open source software
4545
development culture. Jim Jagielski, from The Apache Software Foundation, has listed
4646
them[^4] as:
4747

@@ -52,7 +52,7 @@ them[^4] as:
5252
5. Community
5353
6. Meritocracy
5454

55-
As an organization willing to adopt inner source methodology, the first step is to look
55+
As an organization willing to adopt InnerSource methodology, the first step is to look
5656
how close are organization's principles with these open source ecosytem principles, and
5757
work on minimizing the *deltas* with them.
5858

introduction/scenarios.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
#Inner source scenarios
1+
#InnerSource scenarios
22

3-
Where inner source methodology is being used? Which kind of companies are already
3+
Where InnerSource methodology is being used? Which kind of companies are already
44
using it?
55

6-
In 2000, Tim O'Reilly defined inner source as "the use of open source development
6+
In 2000, Tim O'Reilly defined InnerSource as "the use of open source development
77
techniques within the corporation". Clearly this definition applies to
88
companies developing software for their own use or to be used by
99
third parties.
@@ -20,11 +20,11 @@ Some common open source development techniques are:
2020
- transparent communication: everything, from documents to conversations, is written and
2121
stored, to allow historical review
2222

23-
Inner source, like open source, is well suited for cross-organization collaboration breaking
23+
InnerSource, like open source, is well suited for cross-organization collaboration breaking
2424
boundaries of teams, business units and nations.
2525

2626
Beyond the obvious profile, software development companies, let's see some
27-
scenarios or situations where inner source can help.
27+
scenarios or situations where InnerSource can help.
2828

2929
## The digital transformation wave
3030

0 commit comments

Comments
 (0)