Commit Graph

16 Commits

Author SHA1 Message Date
Zuul 7a82494061 Merge "Re-work the content under Practical Examples" 2021-09-07 18:37:30 +00:00
Zuul 5a5e6acd82 Merge "Polish the Introduction of the Four Opens book" 2021-09-07 18:37:29 +00:00
Ildiko Vancsa 25034fbf95 Re-work the content under Practical Examples
The previous patch moved out the action and examples from
under the Open Community chapter. This patch updates the text
to adjust to the content and flow of the book.

Change-Id: Ib4918697427c20c34a01c699e1741158b83bc7ec
Signed-off-by: Ildiko Vancsa <ildiko.vancsa@gmail.com>
2021-07-26 08:03:27 -07:00
Ildiko Vancsa 0f3e8f2a06 Polish the Introduction of the Four Opens book
The purpose of this patch is to edit the 'Introduction' section
of the Four Opens book. It is the first change of a series that
will go through the entire book to make the text read more neutral
and cohesive to make it ready to publish.

Change-Id: I7829fdfa3cca374032cc99cac4cc3479e694b877
Signed-off-by: Ildiko Vancsa <ildiko.vancsa@gmail.com>
2021-07-20 13:43:56 -07:00
Ildiko Vancsa 5db7e933c2 Restructuring body and text
This change restructures the body of the book to add an
additional chapter about actions and processes.

It also edits the chapters to create a more cohesive
flow and voice through the whole.

Change-Id: I31690e21ecc801e6c62cce57c5ed4174335bdc61
Signed-off-by: Ildiko Vancsa <ildiko.vancsa@gmail.com>
2021-04-06 15:49:06 +02:00
Trinh Nguyen 0bf814f232 Some edit to the Open Community document
Change-Id: Ie78cdb59690fecfb9e75973609198b77bd53c1a1
Signed-off-by: Trinh Nguyen <dangtrinhnt@gmail.com>
2019-07-17 16:45:16 +00:00
Zuul b5f5fe2524 Merge "Reword open design overview section" 2019-07-15 15:09:35 +00:00
Amy Marrich (spotz) ac65802b6e First edit of the Open Community section
Updated some wording and formatting.

Change-Id: I1c070f1f35b85bf507a690a89dd65633d0317691
2019-07-11 20:02:04 -05:00
Sean McGinnis ba8cfec5a5
Reword open design overview section
I found some of the phrasing a little awkward in the open design doc.
This is an attempt to clarify some of it and hopefully make it flow a
little better.

Change-Id: Iafb023b0f0a955abb2533cff16803461b99e30d4
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-07-10 15:25:17 -05:00
Andreas Jaeger 6c46a48c40 Small update for opendevelopment
Convert paragraph to a list, this looks like a formatting problem.

Add reference to the opencommunity chapter.

Change-Id: Ib342de96058a891a6e0999ee2e09a743b45001a3
2018-11-16 11:18:22 +01:00
Andreas Jaeger 83234fd752 Reorder sections
Use the same ordering in the index file as the governance repository
uses. This seems to have been the intented work flow as section
opendevelopment also speaks about next chapter opencommunity.

My initial creation of the index file gave here the wrong order.

Change-Id: Iaf225a36c22032c95667b540afdcacbf99125d73
2018-11-16 11:18:22 +01:00
Andreas Jaeger e9e55e91f5 Call document "The Four Opens"
Update sphinx configuration to use "The Four Opens" instead of "Four
Opens".

Change-Id: I29f1abe1839ef3d86640ba1a2ae982d027d0ad39
2018-11-16 11:18:22 +01:00
Andreas Jaeger eca2db19a5 Reformat opencommunity.rst
Add markup for headings and definition lists to better visualize the
structure of the document.

Change-Id: I89f1871643667eeed917b18431c99d85682cd737
2018-11-16 11:18:17 +01:00
Andreas Jaeger 30ef8472fa Enable linting
Enable linting with doc8 and fix all problems found so that it passes.

Change-Id: I052a1b8d016ae396917ae06c22ec29062aa10a2a
2018-11-14 17:23:22 +01:00
Andreas Jaeger 63d7a30840 Enable sphinx warnings
Tread warnings as errors - and fix all warnings.

Change-Id: I864fbc9cbe4a11c163505a10471dee869bcb1328
2018-11-14 17:18:38 +01:00
Andreas Jaeger b3bd57cf18 Adding test infrastructure
Setup repo for usual Sphinx location:
* content lives in doc/source
* Add tox.ini for building with linter and docs job
* Add doc/source/conf.py for Sphinx
* Add index file to build a manual
* Add jobs for Zuul; note that tox-linters is non-voting for now, fixing
  issues can be done as followup.
  The docs job has Sphinx warnings disabled, this will be a followup as
  well.
* Add .gitignore for usual build artefacts

Change-Id: Ie7af4b6bd661e61180528cc1ecf3076e3e95590b
2018-11-14 16:01:17 +01:00