Skip to content

Commit 584be30

Browse files
committed
Minor markdown fixes, incl title-casing of titles
1 parent 66fd0c0 commit 584be30

File tree

4 files changed

+24
-32
lines changed

4 files changed

+24
-32
lines changed

infrastructure/assessment.md

+8-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Comparing how inner-sourced your infrastructure is
1+
# Comparing How InnerSourced your Infrastructure is
22

33
Just detailing the infrastructure needed within an organization to effectively
44
apply InnerSource would be simplistic. This section aims at listing the
@@ -16,7 +16,7 @@ platform to share technical decisions.
1616
For each of those, we need to check if they are following the key aspects
1717
provided such as openness.
1818

19-
**Development process infrastructure**
19+
## Development Process Infrastructure
2020

2121
| | Openness | Transparency | Archivable | Searchable | Monitoring | Access Rights |
2222
|---------------------|----------|--------------|------------|------------|------------|---------------|
@@ -26,30 +26,25 @@ provided such as openness.
2626
| CI | | | | | | |
2727
| Wiki/Documentation | | | | | | |
2828
| TODO List | | | | | | |
29-
| Collaborative notes | | | | | | ||
30-
31-
32-
**Communication Channels Infrastructure**
29+
| Collaborative notes | | | | | | |
3330

31+
## Communication Channels Infrastructure
3432

3533
| | Openness | Transparency | Archivable | Searchable | Monitoring | Access Rights |
3634
|---------------------|----------|--------------|------------|------------|------------|---------------|
3735
| Mailing lists/forums| | | | | | |
3836
| Instant channels | | | | | | |
39-
| Questions/Answers | | | | | | ||
40-
37+
| Questions/Answers | | | | | | |
4138

42-
**Monitoring Infrastructure**
39+
## Monitoring Infrastructure
4340

4441
| | Openness | Transparency | Archivable | Searchable | Monitoring | Access Rights |
4542
|-------------------------|----------|--------------|------------|------------|------------|---------------|
4643
| Retrieval platform | | | | | | |
4744
| Enrichment platform | | | | | | |
48-
| Visualization platform | | | | | | ||
49-
50-
45+
| Visualization platform | | | | | | |
5146

52-
# Some examples of Infrastructure
47+
# Some Examples of Infrastructure
5348

5449
GitHub enterprise.
5550
GitLab.

infrastructure/authors.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
# Authors and Reviewers
2+
13
## Authors
24

35
(Chronological order)
46

5-
- Daniel Izquierdo ([Bitergia](http://bitergia.com))
7+
- Daniel Izquierdo ([Bitergia](http://bitergia.com))
68

79
## Reviewers
810

infrastructure/basics.md

+13-17
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ process needs a large set of actions and those actions should have the
5353
confirmation that they are working. For this the organization and its
5454
business units need of a monitoring infrastructure.
5555

56-
## Development process infrastructure
56+
## Development Process Infrastructure
5757

5858
When developing there are three main tools to take into account: the versioning
5959
, code review and continuous integration systems. Those should follow a process
@@ -82,14 +82,14 @@ to the submitter (7: Review process -> Updated Copy of Upstream).
8282

8383
![Usual software development process](development_workflow.jpg)
8484

85-
* ** Versioning system **: this tool is used by developers to store the
85+
* **Versioning system**: this tool is used by developers to store the
8686
several iterations of a given piece of software. As developers are basically
8787
geographically distributed, the versioning system should allow this type of
8888
interactions, where any developer at any time may submit a piece of code
8989
to be reviewed. Systems that allow off-line development are highly
9090
recommended as developers will be able to locally work and later submit the code.
9191

92-
* ** Code review system **: once the piece of code is ready to be submitted,
92+
* **Code review system**: once the piece of code is ready to be submitted,
9393
this should be previously reviewed by another developer. This forces developers
9494
to submit that piece of code through a specific process. As an example,
9595
there are several ways where open source communities code review others, using
@@ -102,7 +102,7 @@ piece of source code without needing to submit that to review. Early discussions
102102
in the code review process helps to produce better code and having mentors
103103
involved in the process.
104104

105-
* ** Continuous integration (CI) system **: this is one of the key tooling when
105+
* **Continuous integration (CI) system**: this is one of the key tooling when
106106
developing. There are already several eyes having a look at the source code
107107
in the code review process. With the addition of a continuous integration
108108
platform, any type of test should be covered: regression, unit testing, end
@@ -111,7 +111,7 @@ review process. In this way, developers can wait for the answer for the CI
111111
system before proceeding with the code review process. They would be sure
112112
that this works prior any effort from them.
113113

114-
* ** Ticketing system **: tickets are useful to attract community to an
114+
* **Ticketing system**: tickets are useful to attract community to an
115115
InnerSource project. This helps in two specific ways: transparency of the
116116
development process, raising issues and having a roadmap of the issues
117117
to be closed. And in second place, to provide a platform for newcomers and
@@ -123,7 +123,7 @@ is key to let developers know about the community and business units needs.
123123
Then all of this can be discussed during the design summits defining further
124124
roadmaps based on users, developers and organizations requirements.
125125

126-
* ** Documentation system **: documentation is now available to any member
126+
* **Documentation system**: documentation is now available to any member
127127
of the organization. And documentation has extra goals when producing it. Not
128128
only to developers, but to users. Indeed the documentation should be focused
129129
on several roles. From developers to users, the documentation should cover
@@ -137,7 +137,7 @@ the documentation also covers information as general as the mission and
137137
the type of things that the piece of code does and the things that this does
138138
not do.
139139

140-
* ** Collaborative design platform **: InnerSource in large organizations
140+
* **Collaborative design platform**: InnerSource in large organizations
141141
is a synonym of geographically distributed teams. Face to face meetings are
142142
hard to have in this type of organizations, but there should exist infrastructure
143143
to bridge those difficulties. Requirements specifications, technical decisions,
@@ -149,8 +149,7 @@ by others within the organization.
149149

150150
![Extended usual software development process](development_workflow_all.jpg)
151151

152-
153-
## Communication channels infrastructure
152+
## Communication Channels Infrastructure
154153

155154
InnerSource is about cultural change. And that cultural change is based on
156155
transparency and meritocracy. Communication channels should be open within
@@ -159,32 +158,30 @@ the organization, and anyone is allowed to post to them.
159158
Any decision out of the public channels should be later written down in these
160159
as any decision should be traceable and referenceable.
161160

162-
163-
* ** Mailing Lists / Forums **: this asynchronous way of communicating across the
161+
* **Mailing Lists / Forums**: this asynchronous way of communicating across the
164162
developer teams is highly effective. Being geographically distributed force
165163
the members of the organization to avoid direct communication channels
166164
when possible as people lives in different time zones.
167165

168-
* ** Instant Messaging **: this is another asynchronous communication channel.
166+
* **Instant Messaging**: this is another asynchronous communication channel.
169167
From the usual IRC channels used in open source software, to other open
170168
source options such as Mattermost, this helps to lead technical discussions,
171169
store the log information and have all of the developers in a virtual room
172170
where they can discuss, but also users can enter looking for advice.
173171

174-
* ** Questions / Answers **: this type of platforms help to raise questions and
172+
* **Questions / Answers**: this type of platforms help to raise questions and
175173
share those with the rest of the community. Users and developers can vote
176174
the most interesting ones and this helps to bring attention to issues of interest
177175
for the internal inner-sourced community.
178176

179-
* ** Video conference **: face to face meeting definitively helps. And even more
177+
* **Video conference**: face to face meeting definitively helps. And even more
180178
when discussing about technical issues. This type of synchronous communication
181179
channels are useful for discussions but force people to be at the same time
182180
in the same virtual room. As there could be members from several time zones,
183181
those are more difficult to set than conversations in the instant messaging
184182
or mailing lists.
185183

186-
187-
## Monitoring infrastructure
184+
## Monitoring Infrastructure
188185

189186
This infrastructure is needed to understand the current situation of the
190187
software development process and should help in the decision making process.
@@ -215,7 +212,6 @@ the several data layers, from raw information to detailed visualizations.
215212

216213
![Monitoring Infrastructure](monitoring_infrastructure.jpg)
217214

218-
219215
* **Retrieval Platform**: this first part uses as input any of the data
220216
sources already mentioned. Version systems, mailing lists, tickets,
221217
collaborative documents and others should have some way of retrieving

infrastructure/infrastructure.md

-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ and mined.
9797
The infrastructure should allow this roles division. Anyone is welcome to read,
9898
but some of them are allowed to write.
9999

100-
101100
All of these are probably already known as those are key aspects when deploying
102101
infrastructure in open source projects. There are two great books that have already
103102
dealt with this issue. [_Producing Open Source Software_ by _Karl Fogel_](http://producingoss.com/)

0 commit comments

Comments
 (0)