You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@aurora.apache.org by "Dave Lester (JIRA)" <ji...@apache.org> on 2014/12/23 21:09:14 UTC
[jira] [Updated] (AURORA-981) Dynamically generate table of
contents for documentation
[ https://issues.apache.org/jira/browse/AURORA-981?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dave Lester updated AURORA-981:
-------------------------------
Labels: Website (was: )
> 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
> Labels: Website
>
> 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)