@@ -53,7 +53,7 @@ process needs a large set of actions and those actions should have the
5353confirmation that they are working. For this the organization and its
5454business units need of a monitoring infrastructure.
5555
56- ## Development process infrastructure
56+ ## Development Process Infrastructure
5757
5858When 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
8686several iterations of a given piece of software. As developers are basically
8787geographically distributed, the versioning system should allow this type of
8888interactions, where any developer at any time may submit a piece of code
8989to be reviewed. Systems that allow off-line development are highly
9090recommended 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,
9393this should be previously reviewed by another developer. This forces developers
9494to submit that piece of code through a specific process. As an example,
9595there 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
102102in the code review process helps to produce better code and having mentors
103103involved 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
106106developing. There are already several eyes having a look at the source code
107107in the code review process. With the addition of a continuous integration
108108platform, 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
111111system before proceeding with the code review process. They would be sure
112112that 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
115115InnerSource project. This helps in two specific ways: transparency of the
116116development process, raising issues and having a roadmap of the issues
117117to 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.
123123Then all of this can be discussed during the design summits defining further
124124roadmaps 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
127127of the organization. And documentation has extra goals when producing it. Not
128128only to developers, but to users. Indeed the documentation should be focused
129129on 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
137137the type of things that the piece of code does and the things that this does
138138not do.
139139
140- * ** Collaborative design platform ** : InnerSource in large organizations
140+ * ** Collaborative design platform** : InnerSource in large organizations
141141is a synonym of geographically distributed teams. Face to face meetings are
142142hard to have in this type of organizations, but there should exist infrastructure
143143to 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
155154InnerSource is about cultural change. And that cultural change is based on
156155transparency and meritocracy. Communication channels should be open within
@@ -159,32 +158,30 @@ the organization, and anyone is allowed to post to them.
159158Any decision out of the public channels should be later written down in these
160159as 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
164162developer teams is highly effective. Being geographically distributed force
165163the members of the organization to avoid direct communication channels
166164when 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.
169167From the usual IRC channels used in open source software, to other open
170168source options such as Mattermost, this helps to lead technical discussions,
171169store the log information and have all of the developers in a virtual room
172170where 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
175173share those with the rest of the community. Users and developers can vote
176174the most interesting ones and this helps to bring attention to issues of interest
177175for 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
180178when discussing about technical issues. This type of synchronous communication
181179channels are useful for discussions but force people to be at the same time
182180in the same virtual room. As there could be members from several time zones,
183181those are more difficult to set than conversations in the instant messaging
184182or mailing lists.
185183
186-
187- ## Monitoring infrastructure
184+ ## Monitoring Infrastructure
188185
189186This infrastructure is needed to understand the current situation of the
190187software 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
220216sources already mentioned. Version systems, mailing lists, tickets,
221217collaborative documents and others should have some way of retrieving
0 commit comments