Details

    • Improvement
    • Resolution: Unresolved
    • Minor
    • None
    • None
    • 3
    • 9223372036854775807

    Description

      The following pages are all over 3 years old.  These are being reviewed as part of the efforts of the Lustre Documentation Working Group.  The main intent of this bug is to evaluate if these pages require:

      • Reorganization
      • Removal due to staleness
      • Extension due to missing material
      • Correction to fix incorrect or stale material

      The author is expected to annotate this work item with the changes expected.  They may or may not make those changes as part of this work item.  If they choose to not make those changes, they are expected to create a new work item where the identified, explicit improvements can be made by another individual within the LUDOC stream.  If they do choose to make those changes, please clarify such in the comment section.

      The full list of pages include:

      [Lustre Internals (Old)
      |https://wiki.lustre.org/Lustre_Internals_(Old)]‏‎ (07:43, 2 November 2016)

      [Lustre Internals|https://wiki.lustre.org/Lustre_Internals]‏‎ (12:00, 4 March 2016)

      [Lustre Internals Documentation Update|https://wiki.lustre.org/Lustre_Internals_Documentation_Update]‏‎ (09:00, 18 October 2018)

      Attachments

        Activity

          [LUDOC-541] Lustre Wiki: Review Lustre Internal Pages
          georgea Anjus George added a comment -

          Regarding the second link in the original issue:

          [Lustre Internals|https://wiki.lustre.org/Lustre_Internals]‏‎ (12:00, 4 March 2016)

          I don't think this page adds any value to the Lustre wiki. It contains a broken link (https://wiki.old.lustre.org/lid) and link to a stale page (https://wiki.old.lustre.org/index.php/Lustre_Design_Document_Archive). 

          The latter is not broken at least, but is labeled as old Lustre wiki and shows in the process of being retired. Also it is a design document archive containing links to HLD and detailed design documents.

          Is there another place where we can link the latter link or will it be completely retired.

          Either way I think we can safely eliminate this page: [Lustre Internals|https://wiki.lustre.org/Lustre_Internals]‏‎ (12:00, 4 March 2016).

          georgea Anjus George added a comment - Regarding the second link in the original issue: [Lustre Internals |https://wiki.lustre.org/Lustre_Internals]‏‎ (12:00, 4 March 2016) I don't think this page adds any value to the Lustre wiki. It contains a broken link ( https://wiki.old.lustre.org/lid) and link to a stale page ( https://wiki.old.lustre.org/index.php/Lustre_Design_Document_Archive).  The latter is not broken at least, but is labeled as old Lustre wiki and shows in the process of being retired. Also it is a design document archive containing links to HLD and detailed design documents. Is there another place where we can link the latter link or will it be completely retired. Either way I think we can safely eliminate this page: [Lustre Internals |https://wiki.lustre.org/Lustre_Internals]‏‎ (12:00, 4 March 2016).
          georgea Anjus George added a comment -

          I have implemented the changes based on suggestions 1 and 3.

          Regarding suggestion 2, I still don’t believe modifying the actual URLs of the presentations is a good idea. These presentations date back to 2008, and it’s likely that a significant number of other technical documents, publications, presentations, or wiki pages link to them. Changing the original URLs could lead to broken links (404 errors) for those existing references. Additionally, many of those documents and presentations have been reviewed and finalized, so altering the URLs would invalidate the references they contain.

          If you think, there is value in doing this, feel free to modify them.

          georgea Anjus George added a comment - I have implemented the changes based on suggestions 1 and 3. Regarding suggestion 2, I still don’t believe modifying the actual URLs of the presentations is a good idea. These presentations date back to 2008, and it’s likely that a significant number of other technical documents, publications, presentations, or wiki pages link to them. Changing the original URLs could lead to broken links (404 errors) for those existing references. Additionally, many of those documents and presentations have been reviewed and finalized, so altering the URLs would invalidate the references they contain. If you think, there is value in doing this, feel free to modify them.
          elliswilson Ellis Wilson added a comment -

          Anjus – I think there is value in keeping the presentations around.  My vote would be to do the following:

          1. Rename the page "Old Lustre Advanced Training Class" and rework the content to indicate that this was that course rather than anything related to "Lustre Internals," which I think we should keep specifically for the ORNL document.

          2. I would personally rename the presentations to eliminate the name "LustreInternals_" from their prefix.  I see the value in doing this outweighing the cost of breaking links elsewhere.

          3. I would then link this "Old Lustre Advanced Training Class" from https://wiki.lustre.org/Lustre_Conferences - at the bottom you'll see "Other Lustre Related Events"

          But you are doing this work, so if you disagree with any of the above please feel free to move ahead as you see fit!

          elliswilson Ellis Wilson added a comment - Anjus – I think there is value in keeping the presentations around.  My vote would be to do the following: 1. Rename the page "Old Lustre Advanced Training Class" and rework the content to indicate that this was that course rather than anything related to "Lustre Internals," which I think we should keep specifically for the ORNL document. 2. I would personally rename the presentations to eliminate the name "LustreInternals_" from their prefix.  I see the value in doing this outweighing the cost of breaking links elsewhere. 3. I would then link this "Old Lustre Advanced Training Class" from https://wiki.lustre.org/Lustre_Conferences - at the bottom you'll see "Other Lustre Related Events" But you are doing this work, so if you disagree with any of the above please feel free to move ahead as you see fit!
          georgea Anjus George added a comment -

          I went through the page given below and have some suggestions on how can it be modified.

          Link: https://wiki.lustre.org/Lustre_Internals_(Old)

          This page contains links to three presentations. And lists topic names, only topic names from these three presentations.The presentations are from 2008.

          1. Lustre Architecture
          2. Log Analysis
          3. Sample Lustre Implementation

          My suggestion is to get rid of this page and probably move the presentation links to a presentation archive page (if we have a page for that).

          It is good to maintain a page to archive the presentations from old conferences and outdated slides and ppts/pdfs on Lustre.

          We can also categorize the old presentations based on the topics covered in them.

          When archiving these presentations, I recommend keeping their original wiki.lustre url intact and just moving the link to the archive page. That way other technical documents/publications citing these presentations will still have their reference urls preserved.

          @Ellis Wilson, what do you think? I would be happy to make these changes if that works for you.

           

          About the topics in these three presentations:

          1. The first presentation is about Lustre architecture. There is an outdated link in this presentation that does not work.

          Topics covered: lnet, ext, things related to I/O Metadata etc.

          2. The second presentation is about log analysis - log analysis tools, stack traces, lock dumps.

          3. Third presentation talks about Lustre implementation: mounting process, open process, rpcs etc.

          georgea Anjus George added a comment - I went through the page given below and have some suggestions on how can it be modified. Link: https://wiki.lustre.org/Lustre_Internals_(Old) This page contains links to three presentations. And lists topic names, only topic names from these three presentations.The presentations are from 2008. Lustre Architecture Log Analysis Sample Lustre Implementation My suggestion is to get rid of this page and probably move the presentation links to a presentation archive page (if we have a page for that). It is good to maintain a page to archive the presentations from old conferences and outdated slides and ppts/pdfs on Lustre. We can also categorize the old presentations based on the topics covered in them. When archiving these presentations, I recommend keeping their original wiki.lustre url intact and just moving the link to the archive page. That way other technical documents/publications citing these presentations will still have their reference urls preserved. @Ellis Wilson, what do you think? I would be happy to make these changes if that works for you.   About the topics in these three presentations: 1. The first presentation is about Lustre architecture. There is an outdated link in this presentation that does not work. Topics covered: lnet, ext, things related to I/O Metadata etc. 2. The second presentation is about log analysis - log analysis tools, stack traces, lock dumps. 3. Third presentation talks about Lustre implementation: mounting process, open process, rpcs etc.

          People

            georgea Anjus George
            elliswilson Ellis Wilson
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: