Details

    • New Feature
    • Resolution: Fixed
    • Blocker
    • Lustre 2.13.0 Manual
    • None
    • None
    • 9223372036854775807

    Description

      User documentation is needed for phase 1 of the PCC feature being introduced in LU-10092.

      Attachments

        Issue Links

          Activity

            [LUDOC-432] Create documentation for PCC Feature
            jgmitter Joseph Gmitter (Inactive) added a comment - The https://review.whamcloud.com/36518 patch has been moved to LUDOC-459

            Yingjin Qian (qian@ddn.com) uploaded a new patch: https://review.whamcloud.com/36518
            Subject: LUDOC-432 pcc: Add PCC-RO documentation
            Project: doc/manual
            Branch: master
            Current Patch Set: 1
            Commit: c0a1964c67c682fcabca4493af4e1adfe07afe70

            gerrit Gerrit Updater added a comment - Yingjin Qian (qian@ddn.com) uploaded a new patch: https://review.whamcloud.com/36518 Subject: LUDOC-432 pcc: Add PCC-RO documentation Project: doc/manual Branch: master Current Patch Set: 1 Commit: c0a1964c67c682fcabca4493af4e1adfe07afe70

            Yingjin Qian (qian@ddn.com) uploaded a new patch: https://review.whamcloud.com/34769
            Subject: LUDOC-432 pcc: Persistent Client Cache documentation
            Project: doc/manual
            Branch: master
            Current Patch Set: 1
            Commit: 48857bfb7255cdbe54651f42d70c658e71e18c0e

            gerrit Gerrit Updater added a comment - Yingjin Qian (qian@ddn.com) uploaded a new patch: https://review.whamcloud.com/34769 Subject: LUDOC-432 pcc: Persistent Client Cache documentation Project: doc/manual Branch: master Current Patch Set: 1 Commit: 48857bfb7255cdbe54651f42d70c658e71e18c0e

            Hi Joe,

            I have already started to write the PCC documentation.

            I will try to give out a initial version of PCC manual by this weekend.

             

            Thanks,

            Qian

            qian_wc Qian Yingjin added a comment - Hi Joe, I have already started to write the PCC documentation. I will try to give out a initial version of PCC manual by this weekend.   Thanks, Qian

            Qian,

            Any further update on the documentation, how is it progressing?

            Thanks.

            Joe

            jgmitter Joseph Gmitter (Inactive) added a comment - Qian, Any further update on the documentation, how is it progressing? Thanks. Joe

            Qian,

            The documentation language is a bit cumbersome, but the process is well documented here: http://wiki.lustre.org/Lustre_Manual_Changes.

            What seems to work best for those not familiar with docbook xml is to first put together the documentation in self-contained MS word document or a single wiki page.  If you have all that self contained, I can help you to translate it to docbook.

            Thanks.
            Joe

            jgmitter Joseph Gmitter (Inactive) added a comment - Qian, The documentation language is a bit cumbersome, but the process is well documented here: http://wiki.lustre.org/Lustre_Manual_Changes. What seems to work best for those not familiar with docbook xml is to first put together the documentation in self-contained MS word document or a single wiki page.  If you have all that self contained, I can help you to translate it to docbook. Thanks. Joe

            Hi Joe,

            I will work on it.

            Btw, what's the format of the documentation of PCC feature?

             

            Regards,

            Qian

            qian_wc Qian Yingjin added a comment - Hi Joe, I will work on it. Btw, what's the format of the documentation of PCC feature?   Regards, Qian

            Qian,

            Will you be able to pull that information together into a patch?

            Thanks.

            Joe

            jgmitter Joseph Gmitter (Inactive) added a comment - Qian, Will you be able to pull that information together into a patch? Thanks. Joe

            Per Qian:
            We already have PCC HLD and paper for SC19 and a simple PCC howto: https://wiki.whamcloud.com/display/ENG/PCC+Howto+Guide, I think most their content can be reused as the PCC documentation writing.

            jgmitter Joseph Gmitter (Inactive) added a comment - Per Qian: We already have PCC HLD and paper for SC19 and a simple PCC howto: https://wiki.whamcloud.com/display/ENG/PCC+Howto+Guide , I think most their content can be reused as the PCC documentation writing.

            Hi Qian,

            Is there any progress on the documentation patch?  We will need this to be submitted before feature landing in a few weeks.

            Thanks.

            Joe

            jgmitter Joseph Gmitter (Inactive) added a comment - Hi Qian, Is there any progress on the documentation patch?  We will need this to be submitted before feature landing in a few weeks. Thanks. Joe

            People

              qian_wc Qian Yingjin
              jgmitter Joseph Gmitter (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: