aurora-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dave Lester (JIRA)" <j...@apache.org>
Subject [jira] [Created] (AURORA-981) Dynamically generate table of contents for documentation
Date Tue, 23 Dec 2014 20:09:14 GMT
Dave Lester created AURORA-981:
----------------------------------

             Summary: Dynamically generate table of contents for documentation
                 Key: AURORA-981
                 URL: https://issues.apache.org/jira/browse/AURORA-981
             Project: Aurora
          Issue Type: Task
          Components: Documentation
            Reporter: Dave Lester
            Assignee: Dave Lester


The Aurora documentation tends to be lengthy, and as a result many pages require a table of
contents to easily navigate their contents. This is currently maintained manually, and has
a few shortcomings:

1) It becomes out of date quickly as documents are revised
2) It cannot be easily styled without adding additional markup
3) There are large inconsistencies in the ToC that documents currently have

Instead, I'd like to see us remove the static ToC that currently exists in the docs, and instead
generate them when they are rendered by the website's Middleman CMS. 



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message