Uploaded image for project: 'Lustre Documentation'
  1. Lustre Documentation
  2. LUDOC-120

Add navigation to the HTML version of the manual

Details

    • Improvement
    • Resolution: Fixed
    • Minor
    • None
    • None
    • 2
    • 6128

    Description

      Create a more granular navigation structure for the Lustre manual.

      Attachments

        Issue Links

          is related to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. LUDOC-119 Segment HTML version of Lustre manual

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Activity

            [LUDOC-120] Add navigation to the HTML version of the manual
            rhenwood Richard Henwood (Inactive) added a comment -

            Webhelp is a chunked html output format in the DocBook xslt stylesheets that was introduced in version 1.76.1.

            I've got it working locally, but Docbook 1.76.1 isn't included in CentOS 6 (which is the current manual builder version).

            So, a path forward here is update the manual builder to CentOS 7 and land this patch:
            http://review.whamcloud.com/#/c/18087

            rhenwood Richard Henwood (Inactive) added a comment - Webhelp is a chunked html output format in the DocBook xslt stylesheets that was introduced in version 1.76.1. I've got it working locally, but Docbook 1.76.1 isn't included in CentOS 6 (which is the current manual builder version). So, a path forward here is update the manual builder to CentOS 7 and land this patch: http://review.whamcloud.com/#/c/18087
            rhenwood Richard Henwood (Inactive) added a comment -

            There is a publican build for the template here:

            http://review.whamcloud.com/#change,5836

            rhenwood Richard Henwood (Inactive) added a comment - There is a publican build for the template here: http://review.whamcloud.com/#change,5836
            rhenwood Richard Henwood (Inactive) added a comment -

            Zip version of the Publican rendered manual.

            rhenwood Richard Henwood (Inactive) added a comment - Zip version of the Publican rendered manual.
            rhenwood Richard Henwood (Inactive) added a comment -

            It seems this doesn't render correctly because additional files are missing. This is a zip of the publican output for the manual.

            rhenwood Richard Henwood (Inactive) added a comment - It seems this doesn't render correctly because additional files are missing. This is a zip of the publican output for the manual.
            rhenwood Richard Henwood (Inactive) added a comment -

            An example of what publican can do with respect to navigation.

            rhenwood Richard Henwood (Inactive) added a comment - An example of what publican can do with respect to navigation.
            rhenwood Richard Henwood (Inactive) added a comment -

            Docbook 5 (the version used by our existing Manual) support became experimental in 3.0. The current version is 3.1. I'm investigating it's suitability for the Lustre manual.

            rhenwood Richard Henwood (Inactive) added a comment - Docbook 5 (the version used by our existing Manual) support became experimental in 3.0. The current version is 3.1. I'm investigating it's suitability for the Lustre manual.
            rhenwood Richard Henwood (Inactive) added a comment -

            A further note: Publican version 2.1 is included in CentOS 6.

            rhenwood Richard Henwood (Inactive) added a comment - A further note: Publican version 2.1 is included in CentOS 6.
            rhenwood Richard Henwood (Inactive) added a comment -

            I was pottering around recently and found the fedora documentation to be pleasantly produced. A brief investigation led me to 'publican'

            http://jfearn.fedorapeople.org/en-US/Publican/2.7/html/Users_Guide/

            I think publican can give us the desired navigation.

            rhenwood Richard Henwood (Inactive) added a comment - I was pottering around recently and found the fedora documentation to be pleasantly produced. A brief investigation led me to 'publican' http://jfearn.fedorapeople.org/en-US/Publican/2.7/html/Users_Guide/ I think publican can give us the desired navigation.
            linda Linda Bebernes (Inactive) added a comment -

            This is a nice example. Unfortunately, I haven't been able to find out which tools were used.
            https://developer.tizen.org/documentation/dev-guide

            linda Linda Bebernes (Inactive) added a comment - This is a nice example. Unfortunately, I haven't been able to find out which tools were used. https://developer.tizen.org/documentation/dev-guide
            rhenwood Richard Henwood (Inactive) added a comment -

            Can you provide a description or link(s) to an example of granular navigation done well?

            rhenwood Richard Henwood (Inactive) added a comment - Can you provide a description or link(s) to an example of granular navigation done well?

            People

              LM-Triage Lustre Manual Triage
              linda Linda Bebernes (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: