[LUDOC-432] Create documentation for PCC Feature Created: 31/Jan/19  Updated: 02/Nov/19  Resolved: 02/Nov/19

Status: Resolved
Project: Lustre Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: Lustre 2.13.0 Manual

Type: New Feature Priority: Blocker
Reporter: Joseph Gmitter (Inactive) Assignee: Qian Yingjin
Resolution: Fixed Votes: 0
Labels: None

Issue Links:
Gantt End to End
has to be finished together with LU-10092 PCC: Lustre Persistent Client Cache Resolved
Rank (Obsolete): 9223372036854775807

 Description   

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



 Comments   
Comment by Joseph Gmitter (Inactive) [ 02/Apr/19 ]

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

Comment by Joseph Gmitter (Inactive) [ 08/Apr/19 ]

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.

Comment by Joseph Gmitter (Inactive) [ 08/Apr/19 ]

Qian,

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

Thanks.

Joe

Comment by Qian Yingjin [ 11/Apr/19 ]

Hi Joe,

I will work on it.

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

 

Regards,

Qian

Comment by Joseph Gmitter (Inactive) [ 11/Apr/19 ]

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

Comment by Joseph Gmitter (Inactive) [ 23/Apr/19 ]

Qian,

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

Thanks.

Joe

Comment by Qian Yingjin [ 24/Apr/19 ]

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

Comment by Gerrit Updater [ 27/Apr/19 ]

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

Comment by Gerrit Updater [ 21/Oct/19 ]

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

Comment by Joseph Gmitter (Inactive) [ 02/Nov/19 ]

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

Comment by Gerrit Updater [ 02/Nov/19 ]

Joseph Gmitter (jgmitter@whamcloud.com) 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

Comment by Joseph Gmitter (Inactive) [ 02/Nov/19 ]

PCC doc landed.

Generated at Sat Feb 10 03:42:53 UTC 2024 using Jira 9.4.14#940014-sha1:734e6822bbf0d45eff9af51f82432957f73aa32c.