Re: [ovs-dev] [RFC PATCH v1] docs: Add release feature roadmap.
Thanks for the review Stephen, This document was raised at the OVS DPDK community sync and it was decided not to proceed further with it (mainly due to the overhead entailed in maintaining it and frequency of modifications to the doc that may occur at). Instead roadmaps are going to be flagged via email at the beginning of a release cycle and collateral stored in a public google doc. I appreciate the time you spent reviewing this however. Thanks Ian > On Wed, 2017-09-13 at 22:04 +0100, Ian Stokes wrote: > > Add a document to outline the roadmap of features contributors are > > targeting for upcoming OVS releases. > > > > Signed-off-by: Ian Stokes > > --- > > Documentation/automake.mk |1 + > > Documentation/faq/index.rst |1 + > > Documentation/faq/release_feature_roadmap.rst | 350 > > + > > 3 files changed, 352 insertions(+), 0 deletions(-) create mode > > 100644 Documentation/faq/release_feature_roadmap.rst > > > > diff --git a/Documentation/automake.mk b/Documentation/automake.mk > > index 24fe63d..3e16873 100644 > > --- a/Documentation/automake.mk > > +++ b/Documentation/automake.mk > > @@ -75,6 +75,7 @@ DOC_SOURCE = \ > > Documentation/faq/terminology.rst \ > > Documentation/faq/vlan.rst \ > > Documentation/faq/vxlan.rst \ > > +Documentation/faq/release_feature_roadmap.rst \ > > Looks like you've some extra whitespace here than shouldn't be here. > > > Documentation/internals/index.rst \ > > Documentation/internals/authors.rst \ > > Documentation/internals/bugs.rst \ > > diff --git a/Documentation/faq/index.rst b/Documentation/faq/index.rst > > index 334b828..e865f57 100644 > > --- a/Documentation/faq/index.rst > > +++ b/Documentation/faq/index.rst > > @@ -41,3 +41,4 @@ Open vSwitch FAQ > > terminology > > vlan > > vxlan > > + release_feature_roadmap > > diff --git a/Documentation/faq/release_feature_roadmap.rst > > b/Documentation/faq/release_feature_roadmap.rst > > new file mode 100644 > > index 000..40388f6 > > --- /dev/null > > +++ b/Documentation/faq/release_feature_roadmap.rst > > @@ -0,0 +1,350 @@ > > +.. > > +Licensed under the Apache License, Version 2.0 (the > > +"License"); you > > may > > Ditto (before "Licensed") > > > + not use this file except in compliance with the License. You > > + may > > obtain > > + a copy of the License at > > + > > + http://www.apache.org/licenses/LICENSE-2.0 > > + > > + Unless required by applicable law or agreed to in writing, > software > > + distributed under the License is distributed on an "AS IS" > > + BASIS, > > WITHOUT > > + WARRANTIES OR CONDITIONS OF ANY KIND, either express or > > + implied. See > > the > > + License for the specific language governing permissions and > > limitations > > + under the License. > > + > > + Convention for heading levels in Open vSwitch documentation: > > + > > + === Heading 0 (reserved for the title in a document) > > + --- Heading 1 > > + ~~~ Heading 2 > > + +++ Heading 3 > > + ''' Heading 4 > > + > > + Avoid deeper levels because they do not render well. > > + > > +=== > > +Release Feature Roadmap > > +=== > > + > > +This document provides a feature roadmap for upcoming OVS releases. > > + > > +A few issues to note: > > + > > +* The aim of the roadmap is to provide visibility across the > > +community > > + regarding which features contributors are targeting in the upcoming > > release. > > +* A feature listed on the roadmap is not guaranteed to be upstreamed > > +in the > > + targeted release and a release will not be delayed in order to > > +accommodate > > + features listed in the roadmap. > > +* It is not mandatory to include planned features in the roadmap > > +although it > > + is encouraged. Features not listed but that are submitted will > > +still be > > + reviewed as per usual for a release. > > + > > +-- > > +Adding Features to the Roadmap > > +-- > > nit: overlines aren't necessary, and we don't use them for anything deeper > than the top-level header. Could you drop it here? > > > + > > +When adding a feature to the roadmap a user should be aware of the > > +required fields and expected values as detailed below: > > + > > +* **Contributor**: The name of the person/company contributing the > feature. > > +* **Feature Name**: The name of the feature being contributed. > > +* **Description**: A brief description of the feature being > contributed. > > + > > +--- > > +OVS 2.9 feature Roadmap > > +--- > > + > > ++-- > + > > +| **OVS 2.9 Feature Roadmap** > + > > ++-- > + > > +| > > +|
Re: [ovs-dev] [RFC PATCH v1] docs: Add release feature roadmap.
On Wed, 2017-09-13 at 22:04 +0100, Ian Stokes wrote: > Add a document to outline the roadmap of features contributors are targeting > for upcoming OVS releases. > > Signed-off-by: Ian Stokes > --- > Documentation/automake.mk |1 + > Documentation/faq/index.rst |1 + > Documentation/faq/release_feature_roadmap.rst | 350 > + > 3 files changed, 352 insertions(+), 0 deletions(-) > create mode 100644 Documentation/faq/release_feature_roadmap.rst > > diff --git a/Documentation/automake.mk b/Documentation/automake.mk > index 24fe63d..3e16873 100644 > --- a/Documentation/automake.mk > +++ b/Documentation/automake.mk > @@ -75,6 +75,7 @@ DOC_SOURCE = \ > Documentation/faq/terminology.rst \ > Documentation/faq/vlan.rst \ > Documentation/faq/vxlan.rst \ > +Documentation/faq/release_feature_roadmap.rst \ Looks like you've some extra whitespace here than shouldn't be here. > Documentation/internals/index.rst \ > Documentation/internals/authors.rst \ > Documentation/internals/bugs.rst \ > diff --git a/Documentation/faq/index.rst b/Documentation/faq/index.rst > index 334b828..e865f57 100644 > --- a/Documentation/faq/index.rst > +++ b/Documentation/faq/index.rst > @@ -41,3 +41,4 @@ Open vSwitch FAQ > terminology > vlan > vxlan > + release_feature_roadmap > diff --git a/Documentation/faq/release_feature_roadmap.rst > b/Documentation/faq/release_feature_roadmap.rst > new file mode 100644 > index 000..40388f6 > --- /dev/null > +++ b/Documentation/faq/release_feature_roadmap.rst > @@ -0,0 +1,350 @@ > +.. > +Licensed under the Apache License, Version 2.0 (the "License"); you > may Ditto (before "Licensed") > + not use this file except in compliance with the License. You may > obtain > + a copy of the License at > + > + http://www.apache.org/licenses/LICENSE-2.0 > + > + Unless required by applicable law or agreed to in writing, software > + distributed under the License is distributed on an "AS IS" BASIS, > WITHOUT > + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See > the > + License for the specific language governing permissions and > limitations > + under the License. > + > + Convention for heading levels in Open vSwitch documentation: > + > + === Heading 0 (reserved for the title in a document) > + --- Heading 1 > + ~~~ Heading 2 > + +++ Heading 3 > + ''' Heading 4 > + > + Avoid deeper levels because they do not render well. > + > +=== > +Release Feature Roadmap > +=== > + > +This document provides a feature roadmap for upcoming OVS releases. > + > +A few issues to note: > + > +* The aim of the roadmap is to provide visibility across the community > + regarding which features contributors are targeting in the upcoming > release. > +* A feature listed on the roadmap is not guaranteed to be upstreamed in the > + targeted release and a release will not be delayed in order to accommodate > + features listed in the roadmap. > +* It is not mandatory to include planned features in the roadmap although it > + is encouraged. Features not listed but that are submitted will still be > + reviewed as per usual for a release. > + > +-- > +Adding Features to the Roadmap > +-- nit: overlines aren't necessary, and we don't use them for anything deeper than the top-level header. Could you drop it here? > + > +When adding a feature to the roadmap a user should be aware of the required > +fields and expected values as detailed below: > + > +* **Contributor**: The name of the person/company contributing the feature. > +* **Feature Name**: The name of the feature being contributed. > +* **Description**: A brief description of the feature being contributed. > + > +--- > +OVS 2.9 feature Roadmap > +--- > + > ++--+ > +| **OVS 2.9 Feature Roadmap** + > ++--+ > +| | > ++--+ > +| **Contributor**: *Intel* | > ++--+ > +| **Feature Name**: Keepalive | > ++--+ > +| **Description**: Keepalive feature is aimed at achieving Fastpath Service| > +| Assurance in OVS-DPDK deployments. It adds support for monitoring the | > +| packet processing threads by dispatching heartbeats at regular i
[ovs-dev] [RFC PATCH v1] docs: Add release feature roadmap.
Add a document to outline the roadmap of features contributors are targeting for upcoming OVS releases. Signed-off-by: Ian Stokes --- Documentation/automake.mk |1 + Documentation/faq/index.rst |1 + Documentation/faq/release_feature_roadmap.rst | 350 + 3 files changed, 352 insertions(+), 0 deletions(-) create mode 100644 Documentation/faq/release_feature_roadmap.rst diff --git a/Documentation/automake.mk b/Documentation/automake.mk index 24fe63d..3e16873 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -75,6 +75,7 @@ DOC_SOURCE = \ Documentation/faq/terminology.rst \ Documentation/faq/vlan.rst \ Documentation/faq/vxlan.rst \ +Documentation/faq/release_feature_roadmap.rst \ Documentation/internals/index.rst \ Documentation/internals/authors.rst \ Documentation/internals/bugs.rst \ diff --git a/Documentation/faq/index.rst b/Documentation/faq/index.rst index 334b828..e865f57 100644 --- a/Documentation/faq/index.rst +++ b/Documentation/faq/index.rst @@ -41,3 +41,4 @@ Open vSwitch FAQ terminology vlan vxlan + release_feature_roadmap diff --git a/Documentation/faq/release_feature_roadmap.rst b/Documentation/faq/release_feature_roadmap.rst new file mode 100644 index 000..40388f6 --- /dev/null +++ b/Documentation/faq/release_feature_roadmap.rst @@ -0,0 +1,350 @@ +.. +Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + === Heading 0 (reserved for the title in a document) + --- Heading 1 + ~~~ Heading 2 + +++ Heading 3 + ''' Heading 4 + + Avoid deeper levels because they do not render well. + +=== +Release Feature Roadmap +=== + +This document provides a feature roadmap for upcoming OVS releases. + +A few issues to note: + +* The aim of the roadmap is to provide visibility across the community + regarding which features contributors are targeting in the upcoming release. +* A feature listed on the roadmap is not guaranteed to be upstreamed in the + targeted release and a release will not be delayed in order to accommodate + features listed in the roadmap. +* It is not mandatory to include planned features in the roadmap although it + is encouraged. Features not listed but that are submitted will still be + reviewed as per usual for a release. + +-- +Adding Features to the Roadmap +-- + +When adding a feature to the roadmap a user should be aware of the required +fields and expected values as detailed below: + +* **Contributor**: The name of the person/company contributing the feature. +* **Feature Name**: The name of the feature being contributed. +* **Description**: A brief description of the feature being contributed. + +--- +OVS 2.9 feature Roadmap +--- + ++--+ +| **OVS 2.9 Feature Roadmap** + ++--+ +| | ++--+ +| **Contributor**: *Intel* | ++--+ +| **Feature Name**: Keepalive | ++--+ +| **Description**: Keepalive feature is aimed at achieving Fastpath Service| +| Assurance in OVS-DPDK deployments. It adds support for monitoring the | +| packet processing threads by dispatching heartbeats at regular intervals | +| and the status is updated periodically in OVSDB. In case of heartbeat| +| misses the failure is detected and reported to higher level fault| +| management systems/frameworks. The status can be monitored from OpenStack| +| Ceilometer service. | ++--+ +| **Feature Name**: vHost PMD | ++
