openstack
/
neutron-fwaas-dashboard
Code Issues Proposed changes

doc: remove symlink for releasenotes 

Currently we have a symlink to releasenotes directory in doc/source,
but this confuses the infra translation script and as a result
Zanata (translation platform) has two 'releasenotes' resources
for neutron-fwaas-dashboard. We can use a direct URL in toctree,
so this commit changes the URL of releasenotes in the toctree
to avoid confusing the infra translation script.

It also simplifies the document index page. Previously we have
same strings for title and toctree. This is meaningless.
If we have more contents in future, let's revisit the structure
of the top page.

Change-Id: Id348322bbc0bb134d7e6da1d2f91ec9a1c4ddfe7
This commit is contained in:
Akihiro Motoki 2017-08-21 10:01:17 +00:00
parent 2b622863f1
commit ac4c93bfe1
2 changed files with 1 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/index.rst
View File

@ -20,27 +20,10 @@ Neutron FWaaS Dashboard Project
Neutron FWaaS Dashboard is a horizon plugin for Neutron FWaaS.
User Documentation
------------------
.. toctree::
:maxdepth: 1
install/index
configuration/index
Contributor Guide
-----------------
.. toctree::
:maxdepth: 2
contributor/index
Release Notes
-------------
.. toctree::
:maxdepth: 1
Release Notes <releasenotes/index>
Release Notes <https://docs.openstack.org/releasenotes/neutron-fwaas-dashboard/>

1
doc/source/releasenotes
View File

@ -1 +0,0 @@
../../releasenotes/source