https://jira.whamcloud.com This file is an XML representation of an issue en-us 9.4.14 940014 05-12-2023 https://jira.whamcloud.com/browse/LUDOC-432 Lustre Documentation <p>User documentation is needed for phase 1 of the PCC feature being introduced in <a href="https://jira.whamcloud.com/browse/LU-10092" title="PCC: Lustre Persistent Client Cache" class="issue-link" data-issue-key="LU-10092"><del>LU-10092</del></a>.</p> LUDOC-432

Create documentation for PCC Feature

New Feature Blocker Resolved Fixed Qian Yingjin Joseph Gmitter Thu, 31 Jan 2019 15:25:53 +0000 Sat, 2 Nov 2019 13:49:25 +0000 Sat, 2 Nov 2019 13:49:25 +0000 Lustre 2.13.0 Manual 0 4 <p>Hi Qian,</p> <p>Is there any progress on the documentation patch?  We will need this to be submitted before feature landing in a few weeks.</p> <p>Thanks.</p> <p>Joe</p> <p>Per Qian:<br/> We already have PCC HLD and paper for SC19 and a simple PCC howto: <a href="https://wiki.whamcloud.com/display/ENG/PCC+Howto+Guide" class="external-link" target="_blank" rel="nofollow noopener">https://wiki.whamcloud.com/display/ENG/PCC+Howto+Guide</a>, I think most their content can be reused as the PCC documentation writing.</p> <p>Qian,</p> <p>Will you be able to pull that information together into a patch?</p> <p>Thanks.</p> <p>Joe</p> <p>Hi Joe,</p> <p>I will work on it.</p> <p>Btw, what's the format of the documentation of PCC feature?</p> <p> </p> <p>Regards,</p> <p>Qian</p> <p>Qian,</p> <p>The documentation language is a bit cumbersome, but the process is well documented here: <a href="http://wiki.lustre.org/Lustre_Manual_Changes." class="external-link" target="_blank" rel="nofollow noopener">http://wiki.lustre.org/Lustre_Manual_Changes.</a></p> <p>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.</p> <p>Thanks.<br/> Joe</p> <p>Qian,</p> <p>Any further update on the documentation, how is it progressing?</p> <p>Thanks.</p> <p>Joe</p> <p>Hi Joe,</p> <p>I have already started to write the PCC documentation.</p> <p>I will try to give out a initial version of PCC manual by this weekend.</p> <p> </p> <p>Thanks,</p> <p>Qian</p> <p>Yingjin Qian (qian@ddn.com) uploaded a new patch: <a href="https://review.whamcloud.com/34769" class="external-link" target="_blank" rel="nofollow noopener">https://review.whamcloud.com/34769</a><br/> Subject: <a href="https://jira.whamcloud.com/browse/LUDOC-432" title="Create documentation for PCC Feature" class="issue-link" data-issue-key="LUDOC-432"><del>LUDOC-432</del></a> pcc: Persistent Client Cache documentation<br/> Project: doc/manual<br/> Branch: master<br/> Current Patch Set: 1<br/> Commit: 48857bfb7255cdbe54651f42d70c658e71e18c0e</p> <p>Yingjin Qian (qian@ddn.com) uploaded a new patch: <a href="https://review.whamcloud.com/36518" class="external-link" target="_blank" rel="nofollow noopener">https://review.whamcloud.com/36518</a><br/> Subject: <a href="https://jira.whamcloud.com/browse/LUDOC-432" title="Create documentation for PCC Feature" class="issue-link" data-issue-key="LUDOC-432"><del>LUDOC-432</del></a> pcc: Add PCC-RO documentation<br/> Project: doc/manual<br/> Branch: master<br/> Current Patch Set: 1<br/> Commit: c0a1964c67c682fcabca4493af4e1adfe07afe70</p> <p>The <a href="https://review.whamcloud.com/36518" class="external-link" target="_blank" rel="nofollow noopener">https://review.whamcloud.com/36518</a> patch has been moved to <a href="https://jira.whamcloud.com/browse/LUDOC-459" title="Add PCC RO documentation" class="issue-link" data-issue-key="LUDOC-459">LUDOC-459</a></p> <p>Joseph Gmitter (jgmitter@whamcloud.com) merged in patch <a href="https://review.whamcloud.com/34769/" class="external-link" target="_blank" rel="nofollow noopener">https://review.whamcloud.com/34769/</a><br/> Subject: <a href="https://jira.whamcloud.com/browse/LUDOC-432" title="Create documentation for PCC Feature" class="issue-link" data-issue-key="LUDOC-432"><del>LUDOC-432</del></a> pcc: Persistent Client Cache documentation<br/> Project: doc/manual<br/> Branch: master<br/> Current Patch Set: <br/> Commit: 4d3ff6b9ece3c3f8a9b5d7dc84f2fa25257faebd</p> <p>PCC doc landed.</p> Gantt End to End LU-10092 Development Rank 1|i00ao7: Rank (Obsolete) 9223372036854775807