Uploaded image for project: 'Product Technical Learning'
  1. Product Technical Learning
  2. PTL-9017

DO280-333: Include copy of matching docs in classroom/materials/content

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • DO280 - OSE 3.0 2 20160126, DO280 - OCP 3.4 1 20170330
    • DO280
    • None
    • en-US (English)

      URL:
      Reporter RHNID:
      Section: -
      Language: en-US (English)
      Workaround: instructor must download docs - before they change on the public site - and make available for isolated classrooms.

      Description: DO280-299 was closed... with plan of no docs included in course content.
      >"We have removed the docs from the F0/workstation machine.
      >
      >Maybe open a separate JIRA for doc inclusion - the feeling in the team is that docs are too frequently updated for it to be included safely in UCF"

      but that is exactly why they should part of the course content (not foundation, but the class package). So that the docs which match the version of the software being taught are available. The public docs change to frequently.

      Take the existing DO280 using OpenShift 3.0.1 The public available docs for OCP 3.0 are describing 3.0.2 or later which is a completely different filename and slightly different procedure for installing the quick method. I realize it changed even more with 3.4 (for the update class) but my point is that between releases of the course, the public docs changed and no longer match the materials in the course. hence the docs matching the course, should be included in the course. As another example, the public docs for 3.0 now have a a separate admin guide and install guide. So many of the references in the student guide no longer exist - EXCEPT in the copy of the docs that are available through content/materials classroom web services.

      Additionally, since not all classroom have internet access, and until it is a fully enforced requirement of all classroom setups, than any documentation which is expected for a real installation of a product should be including in the classroom setup. This includes a copy of the public docs for most layered product courses.

      Again, this is bundled in the course packages, not the UCF packages.
      It gets extracted into the F0/classroom /content tree so that it is available via http to the sudents in the classroom.
      It is not put on all workstations.
      It is the docs that match the version of the software used in the class.
      It does not include anything that is available to install via yum from the repos (but those -doc.rpm files should be included in our classroom repos if that is an option).
      It does include any docs that engineering and brand consider the "primary documentation" for the product and which are only available via docs.redhat.com.

            rht-mjarrett Michael Jarrett
            lauber Susan Lauber
            Votes:
            3 Vote for this issue
            Watchers:
            8 Start watching this issue

              Created:
              Updated:
              Resolved: