[LUDOC-432] Create documentation for PCC Feature

• Status: Resolved
• Project: Lustre Documentation
• Fix Version/s: Lustre 2.13.0 Manual
• Type: New Feature
• Priority: Blocker
• Reporter: Joseph Gmitter (Inactive)
• Assignee: Qian Yingjin
• Resolution: Fixed

Description

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

Issue Links

• has to be finished together with: LU-10092 PCC: Lustre Persistent Client Cache

Comments

[Joseph Gmitter (Inactive)]

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

[Joseph Gmitter (Inactive)]

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.

[Joseph Gmitter (Inactive)]

Qian,

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

Thanks.

Joe

[Qian Yingjin]

Hi Joe,

I will work on it.

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

 

Regards,

Qian

[Joseph Gmitter (Inactive)]

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

[Joseph Gmitter (Inactive)]

Qian,

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

Thanks.

Joe

[Qian Yingjin]

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

[Gerrit Updater]

Yingjin Qian ([e-mail]) 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 Updater]

Yingjin Qian ([e-mail]) 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

[Joseph Gmitter (Inactive)]

The https://review.whamcloud.com/36518 patch has been moved to LUDOC-459

[Gerrit Updater]

Joseph Gmitter ([e-mail]) merged in patch https://review.whamcloud.com/34769/
Subject: LUDOC-432 pcc: Persistent Client Cache documentation
Project: doc/manual
Branch: master
Current Patch Set:
Commit: 4d3ff6b9ece3c3f8a9b5d7dc84f2fa25257faebd

[Joseph Gmitter (Inactive)]

PCC doc landed.