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

          Activity

            [LUDOC-120] Add navigation to the HTML version of the manual

            Patches here have been merged a while back.

            jgmitter Joseph Gmitter (Inactive) added a comment - Patches here have been merged a while back.

            Richard Henwood (richard.henwood@intel.com) merged in patch http://review.whamcloud.com/18364/
            Subject: LUDOC-120 webhelp: transform manual to webhelp.
            Project: doc/manual
            Branch: master
            Current Patch Set:
            Commit: 80246f2b00877f6fc49f053884b26f5733c0880b

            gerrit Gerrit Updater added a comment - Richard Henwood (richard.henwood@intel.com) merged in patch http://review.whamcloud.com/18364/ Subject: LUDOC-120 webhelp: transform manual to webhelp. Project: doc/manual Branch: master Current Patch Set: Commit: 80246f2b00877f6fc49f053884b26f5733c0880b

            Richard Henwood (richard.henwood@intel.com) merged in patch http://review.whamcloud.com/18087/
            Subject: LUDOC-120 presentation: build bits for webhelp.
            Project: doc/manual
            Branch: master
            Current Patch Set:
            Commit: 962666465779422201dab192d897b2f886ad1cf0

            gerrit Gerrit Updater added a comment - Richard Henwood (richard.henwood@intel.com) merged in patch http://review.whamcloud.com/18087/ Subject: LUDOC-120 presentation: build bits for webhelp. Project: doc/manual Branch: master Current Patch Set: Commit: 962666465779422201dab192d897b2f886ad1cf0

            The Java requirement is only during the creation of the webhelp format to construct an index. The search in the webhelp output uses this pre-generated index file and javascript. In my experience it out performs ctrl-f. For example, a search of LFSCK pulls up a short list of topic subjects.

            I am in complete support that this is an optional derivative form of the manual - xhtml remains the primary form.

            Thanks for spending time on this.

            rhenwood Richard Henwood (Inactive) added a comment - The Java requirement is only during the creation of the webhelp format to construct an index. The search in the webhelp output uses this pre-generated index file and javascript. In my experience it out performs ctrl-f. For example, a search of LFSCK pulls up a short list of topic subjects. I am in complete support that this is an optional derivative form of the manual - xhtml remains the primary form. Thanks for spending time on this.

            Looks nice, though "Command-F" or "Ctrl-F" searching in the current HTML or PDF doc also works, and doesn't require Java (or whatever) complicating the access and distribution of the manual in HTML format. I'm not against it, but there is also value in simplicity and ease of access/distribution of the document. I definitely don't want this to become the only way to access the manual online.

            adilger Andreas Dilger added a comment - Looks nice, though "Command-F" or "Ctrl-F" searching in the current HTML or PDF doc also works, and doesn't require Java (or whatever) complicating the access and distribution of the manual in HTML format. I'm not against it, but there is also value in simplicity and ease of access/distribution of the document. I definitely don't want this to become the only way to access the manual online.
            rhenwood Richard Henwood (Inactive) added a comment - I was thinking more like this, with search as well: https://build.hpdd.intel.com/job/lustre-manual-reviews/665/artifact/webhelp-out/index.html

            I believe that this exists today. The .xhtml version has a TOC with links to each section of the manual.

            adilger Andreas Dilger added a comment - I believe that this exists today. The .xhtml version has a TOC with links to each section of the manual.

            Richard Henwood (richard.henwood@intel.com) uploaded a new patch: http://review.whamcloud.com/18364
            Subject: LUDOC-120 webhelp: transform manual to webhelp.
            Project: doc/manual
            Branch: master
            Current Patch Set: 1
            Commit: 9b1e424920c8ba7e810fa001fee1994b567c0c2d

            gerrit Gerrit Updater added a comment - Richard Henwood (richard.henwood@intel.com) uploaded a new patch: http://review.whamcloud.com/18364 Subject: LUDOC-120 webhelp: transform manual to webhelp. Project: doc/manual Branch: master Current Patch Set: 1 Commit: 9b1e424920c8ba7e810fa001fee1994b567c0c2d

            Richard Henwood (richard.henwood@intel.com) uploaded a new patch: http://review.whamcloud.com/18284
            Subject: LUDOC-120 webhelp: enable building of webhelp.
            Project: doc/manual
            Branch: master
            Current Patch Set: 1
            Commit: 8784f412619e7fc20045e2b986ebb5704edd2e5f

            gerrit Gerrit Updater added a comment - Richard Henwood (richard.henwood@intel.com) uploaded a new patch: http://review.whamcloud.com/18284 Subject: LUDOC-120 webhelp: enable building of webhelp. Project: doc/manual Branch: master Current Patch Set: 1 Commit: 8784f412619e7fc20045e2b986ebb5704edd2e5f

            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

            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: