| ... |
... |
@@ -171,11 +171,7 @@ This would be the starting/root point for those contents related with the BuildS |
|
171
|
171
|
#### C. BuildStream Code
|
|
172
|
172
|
|
|
173
|
173
|
|
|
174
|
|
-There is a well documented by now change in behavior when it comes to content consumption related with Open Source projects that favors for certain profiles specific repo files over content in other platforms, specially when the information is tightly related with the code.
|
|
175
|
|
-
|
|
176
|
|
-For complex and bigger project this trend represents a challenge since involves content maintenance related risks (inconsistency, duplication, outdated info...), specially when other content platforms are not git based, like in our case, where the GNOME wiki pages are editable.
|
|
177
|
|
-
|
|
178
|
|
-In terms of design, we will need to consider the following, to mitigate such risks:
|
|
|
174
|
+Together with the Download page, the following gitlab files are essential:
|
|
179
|
175
|
|
|
180
|
176
|
* README files will be nothing but a summary of what is present in other pages. Links to those pages will be included in the README file and will need to be maintained.
|
|
181
|
177
|
* BuildStream will have the README file of the master branch as the entry point for contributors, instead of Master (outcome) unit initially. As the tool grows and becomes more mature, this decision might change.
|
| ... |
... |
@@ -185,12 +181,13 @@ In terms of design, we will need to consider the following, to mitigate such ris |
|
185
|
181
|
* C.4 News/Release notes file - R.3 Feature page and D. BuildStream In Detail content units.
|
|
186
|
182
|
* C.5 Maintainers - Pj.5 Community support and Tools content unit.
|
|
187
|
183
|
|
|
|
184
|
+Changelog has not been consider for now, but it will in the future. It is interesting information for a project focus on systems that needs to be maintained for a long time.
|
|
188
|
185
|
|
|
189
|
186
|
C.1 BuildStream download page
|
|
190
|
187
|
|
|
191
|
188
|
The Download page is the central reference not just to download the outcomes delivered by the project, but also the associated metadata. It will also have structured and direct references to all the information required to have a smooth deployment/installation experience.
|
|
192
|
189
|
|
|
193
|
|
-The structure of this unit will consider:
|
|
|
190
|
+This unit will include, at least, the following content:
|
|
194
|
191
|
|
|
195
|
192
|
* Versioning.
|
|
196
|
193
|
* Platforms where BuildStream is expected to be installed.
|
| ... |
... |
@@ -200,7 +197,7 @@ The structure of this unit will consider: |
|
200
|
197
|
* Critical path design to ensure that the journey through BuildStream contents takes place in the pre-established order. This consideration applies in fact to, at least, every unit that is part of the critical path of any considered target audience.
|
|
201
|
198
|
|
|
202
|
199
|
|
|
203
|
|
-C.2 Release branch and master README file
|
|
|
200
|
+C.2 README files
|
|
204
|
201
|
|
|
205
|
202
|
Short, to the point, description of what is BuildStream for and how to consume it, together with links to further information, adding context to each one of them. That additional or complementary information could be (related with):
|
|
206
|
203
|
|
| ... |
... |
@@ -212,7 +209,7 @@ Short, to the point, description of what is BuildStream for and how to consume i |
|
212
|
209
|
Relations: C.2 README.rst - R.2 Master, 0. Landing Page, R.3 Feature Page and R.4 Deployment Howto units.
|
|
213
|
210
|
|
|
214
|
211
|
|
|
215
|
|
-C.3 Release branch and master Copying/LICENSE file
|
|
|
212
|
+C.3 COPYING/LICENSE file
|
|
216
|
213
|
|
|
217
|
214
|
This unit should include:
|
|
218
|
215
|
|
| ... |
... |
@@ -222,7 +219,7 @@ This unit should include: |
|
222
|
219
|
Relations: C.3 LICENSE file - Pj.2 Governance+license+sponsors content units. A complementary proposal related with compliance will be sent.
|
|
223
|
220
|
|
|
224
|
221
|
|
|
225
|
|
-C.4 Release branch and Master (dev releases) NEWS/Release Notes.
|
|
|
222
|
+C.4 NEWS/Release Notes file.
|
|
226
|
223
|
|
|
227
|
224
|
News related with each release (digested release notes). Further content can be considered in this unit or separate ones like:
|
|
228
|
225
|
|
| ... |
... |
@@ -232,7 +229,7 @@ News related with each release (digested release notes). Further content can be |
|
232
|
229
|
Relations: C.4 News/Release notes file - R.3 Feature page and D. BuildStream In Detail content units.
|
|
233
|
230
|
|
|
234
|
231
|
|
|
235
|
|
-C.5 Release branch and master Maintainers file
|
|
|
232
|
+C.5 Maintainers file
|
|
236
|
233
|
|
|
237
|
234
|
List of maintainers, responsibility and contact.
|
|
238
|
235
|
|
