In-tree documentation improvements (LU-1892)

[LU-4932] include design documentation in with the Lustre source code. Created: 21/Apr/14  Updated: 29/Mar/17  Resolved: 28/Aug/15

Status: Resolved
Project: Lustre
Component/s: None
Affects Version/s: None
Fix Version/s: Lustre 2.8.0

Type: Technical task Priority: Critical
Reporter: Richard Henwood (Inactive) Assignee: Richard Henwood (Inactive)
Resolution: Fixed Votes: 0
Labels: None

Issue Links:
Related
is related to LU-5147 Design docs and man pages must be in ... Resolved
Rank (Obsolete): 13636

 Description   

Design documentation for Lustre file system and it's features has traditionally appeared and withered in various wikis and presentations.

The documentation should be kept with the source where it can be reviewed and kept up-to-date.

 Comments   
Comment by Richard Henwood (Inactive) [ 21/Apr/14 ]

first patch for LFSCK is available here:

http://review.whamcloud.com/#/c/10033/

Comment by Peter Jones [ 05/Jun/14 ]

http://review.whamcloud.com/#/c/10040/

Comment by Andreas Dilger [ 05/Jun/14 ]

Richard, the 10033 patch has landed to master for 2.6.0. It would be good to start pushing some of the other docs, like DNE Phase 1, Imperative Recovery, etc.

Comment by Andreas Dilger [ 28/Nov/14 ]

Richard, could you please work with the engineers to submit patches for their design documentation for features that have already landed.

Comment by Richard Henwood (Inactive) [ 04/Dec/14 ]

Yep. LFSCK 3 is in progress:

http://review.whamcloud.com/#/c/10040/3

I will ask Amir for DLC documentation.

Can you help with

LU-3527 - UID/GID Mapping
LU-2182 - Striping API (LLNL)
LU-4665 - OST Placement (ORNL)
LU-5030 - Deprecate procfs (ORNL)

Comment by Richard Henwood (Inactive) [ 04/Dec/14 ]

Also, as per discussion with Doug: the guidance currently is:

+ the format is plain text.
+ diagrams must be in plain text. http://www.asciidraw.com/ and http://asciiflow.com/ may be of interest.

Comment by Richard Henwood (Inactive) [ 16/Jul/15 ]

also

http://review.whamcloud.com/#/c/10618/

Comment by Gerrit Updater [ 20/Aug/15 ]

Andreas Dilger (andreas.dilger@intel.com) merged in patch http://review.whamcloud.com/10040/
Subject: LU-4932 doc: update design doc for LFSCK
Project: fs/lustre-release
Branch: master
Current Patch Set:
Commit: b3a5032f6195cd4cf6ea7f39dd2010c115e99337

Comment by Joseph Gmitter (Inactive) [ 28/Aug/15 ]

Both patches have landed. Closing the ticket. We will open new tickets for any future work needed.

Comment by Gerrit Updater [ 29/Mar/17 ]

Andreas Dilger (andreas.dilger@intel.com) uploaded a new patch: https://review.whamcloud.com/26253
Subject: LU-4932 doc: update LFSCK documentation
Project: fs/lustre-release
Branch: master
Current Patch Set: 1
Commit: 3c5bd6266af83026a08208cef876b848929c74f4

Generated at Sat Feb 10 01:47:06 UTC 2024 using Jira 9.4.14#940014-sha1:734e6822bbf0d45eff9af51f82432957f73aa32c.