diff --git a/doc/source/code-and-documentation/elastic-recheck.rst b/doc/source/code-and-documentation/elastic-recheck.rst index 42db3a4..39c5aa2 100644 --- a/doc/source/code-and-documentation/elastic-recheck.rst +++ b/doc/source/code-and-documentation/elastic-recheck.rst @@ -30,17 +30,13 @@ It is then used to both track the rates those bugs are being found and also to leave comments in gerrit and in IRC when it has found a known bug fingerprint in a failure. -elastic-recheck is built on top of an ELK (`Elastic Search`_, `Logstash`_, -`Kibana`_) stack where we use Logstash to store all logs from CI jobs in an -Elastic Search cluster. We also host a `Kibana dashboard`_ which can be used +elastic-recheck is built on top of an ELK (`Elastic Search +`_, `Logstash `_, +`Kibana `_) stack where we use Logstash to store all logs from CI jobs in an +Elastic Search cluster. We also host a `Kibana dashboard `_ which can be used to run queries on the cluster and interacts with the data. elastic-recheck queries the elastic-search cluster for the fingerprints. -.. _Elastic Search: https://github.com/elastic/elasticsearch -.. _Logstash: https://github.com/elastic/logstash -.. _Kibana: https://github.com/elastic/kibana -.. _Kibana dashboard: http://logstash.openstack.org/ - You can see the current status of the bugs being tracked by elastic recheck at: `Elastic Recheck `_ diff --git a/doc/source/code-and-documentation/using-gerrit.rst b/doc/source/code-and-documentation/using-gerrit.rst index fcb10d6..afc4563 100644 --- a/doc/source/code-and-documentation/using-gerrit.rst +++ b/doc/source/code-and-documentation/using-gerrit.rst @@ -132,7 +132,9 @@ Reviewing Changes Reviewing changes is often suggested as a way to get started on a project. Whether this is how you choose to get started or not, it's an important community activity. See `How to Review Changes the -OpenStack Way`_ for more detailed guidance on when to use which votes +OpenStack Way +`_ +for more detailed guidance on when to use which votes on a change review. **Inline Comments** @@ -254,8 +256,6 @@ you can cherry-pick your own changes on top of it: The change ID is the same as in the previous case. - -.. _How to Review Changes the OpenStack Way: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html .. _+2: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#code-review-plus-2 .. _+1: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#code-review-plus-1 .. _0: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#code-review-0 diff --git a/doc/source/common/governance.rst b/doc/source/common/governance.rst index 26d17c7..3242d54 100644 --- a/doc/source/common/governance.rst +++ b/doc/source/common/governance.rst @@ -23,7 +23,8 @@ The OpenStack Foundation is a non-profit "whose purpose is to develop, support, protect, and promote" OpenStack. It has a set of `bylaws `_ and a board of directors. The Foundation has three types of members, defined by the -bylaws. Each of the types—Platinum, Gold and Individual—are represented on a +bylaws. Each of the types -- Platinum, Gold and Individual -- are +represented on a Board of Directors. Currently there are 24 directors, eight of each type. Individual members of the foundation vote once a year (usually near the start diff --git a/doc/source/common/introduction.rst b/doc/source/common/introduction.rst index 6f9b420..5db9136 100644 --- a/doc/source/common/introduction.rst +++ b/doc/source/common/introduction.rst @@ -12,12 +12,12 @@ OpenStack is a software package that provides a cloud platform for Public and Private cloud covering various use cases including Enterprise and Telecom. The main focus is on Infrastructure as a Service (IaaS) cloud and additional services built upon IaaS. -The Technical Committee maintains an evolving `vision for OpenStack clouds`_ -describing the overall design scope for an OpenStack cloud and the principles -of cloud platforms in general, and OpenStack in particular, that each service -within OpenStack is expected to follow. - -.. _vision for OpenStack clouds: https://governance.openstack.org/tc/reference/technical-vision.html +The Technical Committee maintains an evolving `vision for OpenStack +clouds +`_ +describing the overall design scope for an OpenStack cloud and the +principles of cloud platforms in general, and OpenStack in particular, +that each service within OpenStack is expected to follow. As a software, OpenStack is built from a set of microservices which can be combined into different setups based on the actual need. diff --git a/doc/source/common/task-tracking.rst b/doc/source/common/task-tracking.rst index 6066e35..1a10e44 100644 --- a/doc/source/common/task-tracking.rst +++ b/doc/source/common/task-tracking.rst @@ -28,9 +28,8 @@ Storyboard. Before raising a bug, story or feature request it's important to note that not all projects do the same thing. It's best to go check with the project to see how they handle these requests. For details on how to contact - a project check the `project list`_. - -.. _project list: https://governance.openstack.org/tc/reference/projects/index.html + a project check the `project list + `_. .. _storyboard: diff --git a/doc/source/organizations/index.rst b/doc/source/organizations/index.rst index 0908824..fad9b4e 100644 --- a/doc/source/organizations/index.rst +++ b/doc/source/organizations/index.rst @@ -60,11 +60,10 @@ wear multiple hats. Having engineers spending more time upstream helps everyone by providing continuous input and feedback to tasks that you set as high priority. -But it's more then that, OpenStack relies on `peer review`_. From landing code -to its governance, to function the project needs people in the community -reviewing. - -.. _peer review: https://governance.openstack.org/tc/reference/principles.html#we-value-constructive-peer-review +But it's more then that, OpenStack relies on `peer review +`_. +From landing code to its governance, to function the project needs +people in the community reviewing. Further, having engineers in the community long term will also keep the company ahead of the curve as they are embedded and engaged in the community