From eeefd54c53ae759ea731c47049b2e500e3000c83 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Wed, 13 Nov 2019 04:30:13 +0900 Subject: [PATCH] doc: Adjust heading levels In the openstackdocstheme, one page should have a single title heading (the highest level). If we have multiple title headings, only the first one is shown at the top of the page and the remaining one(s) are not shown in the main contents. (They are shown only in "Page Contents" of the left TOC.) It is confusing a bit. As far as I checked, this happens in two files in the current neutron doc. contributor/policies/neutron-teams.rst: It looks better to introduce a page title and keep the existing titles as subsections. contributor/internals/layer3.rst: There is no need to include a page on the L3 agent as it is a separate page. Change-Id: I354182b900bdd04b4fcd64dcf2adbe00d7f8df5a --- doc/source/contributor/internals/layer3.rst | 5 ++++- .../contributor/policies/neutron-teams.rst | 17 +++++++++++++---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/doc/source/contributor/internals/layer3.rst b/doc/source/contributor/internals/layer3.rst index 607d374a766..911c988bab0 100644 --- a/doc/source/contributor/internals/layer3.rst +++ b/doc/source/contributor/internals/layer3.rst @@ -244,7 +244,10 @@ Provider Networking Neutron can also be configured to create `provider networks <../../admin/archives/adv-features.html#provider-networks>`_. -.. include:: l3_agent_extensions.rst +L3 agent extensions +------------------- + +See :doc:`l3_agent_extensions`. Further Reading --------------- diff --git a/doc/source/contributor/policies/neutron-teams.rst b/doc/source/contributor/policies/neutron-teams.rst index 94009d11100..c8a7cf4cb3f 100644 --- a/doc/source/contributor/policies/neutron-teams.rst +++ b/doc/source/contributor/policies/neutron-teams.rst @@ -1,3 +1,7 @@ +====================== +Neutron Team Structure +====================== + Neutron Core Reviewers ====================== @@ -60,6 +64,9 @@ end with merging code. They are responsible for bug triage and gate issues among other things. Lieutenants have an increased responsibility to ensure gate and bug triage for their area of focus is under control. +Neutron Lieutenants +~~~~~~~~~~~~~~~~~~~ + The following are the current Neutron Lieutenants. +------------------------+---------------------------+----------------------+ @@ -94,11 +101,13 @@ Some notes on the above: agents and ML2. * The client includes commands installed server side. * L3 includes the L3 agent, DVR, Dynamic routing and IPAM. -* Services includes FWaaS and VPNaaS. * Note these areas may change as the project evolves due to code refactoring, new feature areas, and libification of certain pieces of code. * Infra means interactions with infra from a neutron perspective +Sub-project Lieutenants +~~~~~~~~~~~~~~~~~~~~~~~ + Neutron also consists of several plugins, drivers, and agents that are developed effectively as sub-projects within Neutron in their own git repositories. Lieutenants are also named for these sub-projects to identify a clear point of @@ -108,7 +117,7 @@ updating the core review team for the sub-project's repositories. +-------------------------+-----------------------------+-------------------+ | Area | Lieutenant | IRC nick | +=========================+=============================+===================+ -| networking-bgpvpn | Mathieu Rohon | matrohon | +| networking-bgpvpn / | Mathieu Rohon | matrohon | | networking-bagpipe +-----------------------------+-------------------+ | | Thomas Morin | tmorin | +-------------------------+-----------------------------+-------------------+ @@ -173,8 +182,8 @@ Please note that as we adopt to the system above with core specialty in particular areas, we expect this broad core team to shrink as people naturally evolve into an area of specialization. -Neutron Core Reviewer Teams for Plugins and Drivers ---------------------------------------------------- +Core Reviewer Teams for Plugins and Drivers +------------------------------------------- The plugin decomposition effort has led to having many drivers with code in separate repositories with their own core reviewer teams. For each one of these repositories in the following repository list, there is a core team