[jira] Created: (TS-231) sdk files revamp

["Miles Libbey (JIRA)" <ji...@apache.org>]

sdk files revamp
----------------

                 Key: TS-231
                 URL: https://issues.apache.org/jira/browse/TS-231
             Project: Traffic Server
          Issue Type: Improvement
            Reporter: Miles Libbey
            Assignee: Miles Libbey


Need to revamp the sdk docs:
- use ssi to deal with header, footer, and left nav
- add search to header
- get rid of the mega nested left nav toc -- too hard to maintain.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

[jira] Closed: (TS-231) sdk files revamp

["Miles Libbey (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/TS-231?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Miles Libbey closed TS-231.
---------------------------

    Resolution: Fixed

The sdk docs now use ssi to pull in the header (top.html -- which includes search).  The left node toc is done via javascript (and is pulled in via the ssi top.html header) -- in the tocnodes.js file.  Javascript is also used to duplicate the next/prev section down at the bottom of the page.

To add a new page:
- need to start the html doc -- after the title, use <!--#include file="top.html" --> 
- put in the prev/next section.
- write the rest of the page, and close out the html.
- modify the js/tocnodes.js file to include the new page.
- prob need to find the prev/next pages and modify their prev/next as appropriate. 

> sdk files revamp
> ----------------
>
>                 Key: TS-231
>                 URL: https://issues.apache.org/jira/browse/TS-231
>             Project: Traffic Server
>          Issue Type: Improvement
>            Reporter: Miles Libbey
>            Assignee: Miles Libbey
>
> Need to revamp the sdk docs:
> - use ssi to deal with header, footer, and left nav
> - add search to header
> - get rid of the mega nested left nav toc -- too hard to maintain.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.