Enable linting

Enable linting with doc8 and fix all problems found so that it passes.

Change-Id: I052a1b8d016ae396917ae06c22ec29062aa10a2a
This commit is contained in:
Andreas Jaeger 2018-11-14 17:23:22 +01:00
parent 63d7a30840
commit 30ef8472fa
5 changed files with 29 additions and 18 deletions

View File

@ -3,6 +3,8 @@
- build-openstack-docs-pti
check:
jobs:
- tox-linters:
voting: false
- tox-linters
gate:
jobs:
- tox-linters

View File

@ -6,7 +6,8 @@ Where do the Four Opens originate from? They came from a need to do things
differently.
Free software started in the 80s by defining four (initially three)
freedoms [#fourfreedoms]_ that any free software should grant its users. Freedom
freedoms [#fourfreedoms]_ that any free software should grant its
users. Freedom
0 was the freedom to run the program as you wish, for any purpose. Freedom 1
was the freedom to study how the program works, and change it so it does your
computing as you wish. Freedom 2 was the freedom to redistribute copies so you

View File

@ -30,11 +30,17 @@ working in harmony to achieve anything.
Open Community defines how to best align these forces through:
- Common mission & goals. - Effective governance & leadership. - Diversity &
Inclusiveness. - Contributor recognition & motivation. - Communication. -
Branding & positioning (example of collaboration across forces, product
definition). - Education & On-boarding. - Marketing & events. - Ambassadors
& meet-ups. - Cross-community collaboration (NIH).
- Common mission & goals.
- Effective governance & leadership.
- Diversity & Inclusiveness.
- Contributor recognition & motivation.
- Communication.
- Branding & positioning (example of collaboration across forces, product
definition).
- Education & On-boarding.
- Marketing & events.
- Ambassadors & meet-ups.
- Cross-community collaboration (NIH).
Common Mission & Goals
----------------------
@ -200,10 +206,10 @@ ultimately realized that we excluded a large portion of the world where Google
products were inaccessible/unavailable.
Host meetings in way that can be archived and searched so that the
conversations are accessible to all time-zones and participants who do not speak
English as their first language. Internationalization (translation, tool
choices like google docs, time-zones), in general, helps foster a more diverse
group of contributors.
conversations are accessible to all time-zones and participants who do
not speak English as their first language. Internationalization
(translation, tool choices like google docs, time-zones), in general,
helps foster a more diverse group of contributors.
Board meetings in particular should be open so that anyone can dial in.
Notes/re-cap should be sent out to the community at large via mailing lists

View File

@ -24,7 +24,8 @@ evaluating a patch can include:
not introduce regressions?
- Documentation: does a new feature include documentation on what
it does and how to properly configure it?
- Purpose: does the code implement a feature identified in the open design process?
- Purpose: does the code implement a feature identified in the open
design process?
Automation, like automated unit, integration, and style checking, can go a long
way to establishing a baseline standard for new code. Code review by trusted

View File

@ -52,7 +52,8 @@ The "Open Source" Principle in Practice
"Open Source" begins with the choice of license a community applies to its
project. In most cases at the OpenStack Foundation, we use v2.0 of the Apache
License [#apachev2]_. The license meets the requirements of being able to modify and
License [#apachev2]_. The license meets the requirements of being able
to modify and
redistribute a work. It includes a number of provisions that also protect
end-users by granting copyright and patent licenses to all end users, while
limiting liability to the original copyright holder. This patent protection is