[lustre-devel] lustre design docs

[Justin Miller]

I think a central document repository is a good idea, and would be a valuable asset. The plan you outline to collect the documents and metadata first and then convert the most useful documents to a maintainable format makes a lot of sense. In addition to the benefits you identify, it may also allow for the collection of some interesting metrics.

I’d be happy to help with this project.

- Justin Miller


On 5/20/15, 1:06 PM, "lustre-devel on behalf of Vitaly Fertman" <lustre-devel-bounces at lists.lustre.org on behalf of vitaly.fertman at seagate.com> wrote:

>Hi All,
>
>there was an idea to publish existing design docs on opensfs wiki.
>is centralised design repository interesting at all?
>
>currently the existing designs are not in the wiki format, mostly pdf, so this is
>not an ideal doc repository we want to have: not changeable, not maintainable,
>could be outdated, etc, but could be published very quickly.
>
>however, this is not the final step but just a beginning. at the same time, we may get
>some benefits immediately:
>- all the docs are gathered in one centralised place, faster doc search;
>- the fully documented product (although maybe not very up-to-date initially) —
>attractive for many readers, especially newbies;
>- a quick jump to unknown code having a design, faster than reading the source code;
>
>after that, having these docs already published, next steps could be:
>- docs to be split on those which are to be maintained and left untouched;
>- a procedure of converting to be maintained docs to wiki format could be organised; 
>- a procedure of updating converted docs to be organised; 
>etc.
>
>would be valuable? thoughts?
>
>—
>Vitaly?
>_______________________________________________
>lustre-devel mailing list
>lustre-devel at lists.lustre.org
>http://lists.lustre.org/listinfo.cgi/lustre-devel-lustre.org