Uploaded image for project: 'OpenShift Migration Toolkit for Containers'
  1. OpenShift Migration Toolkit for Containers
  2. MIG-523

POC: In-UI, linkable troubleshooting / info doc

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Unresolved
    • Icon: Minor Minor
    • None
    • None
    • None
    • False
    • False
    • ToDo
    • Undefined

      Often a desire to be able to link to a document (specifically to an anchor so it goes directly to that section of the page) that contains troubleshooting or in depth background issue about a subject comes up in UI conversations.

      We'd like to do a POC that would ship a styled HTML page in the UI that we'd be able to publish this information to and to link to. Some requirements:

      • The content should be baked into the image so that it's coupled to the same version of the installed MTC.
      • It should be very easy to author (add/edit) to the doc, so ideally the actual content should be a markdown document that's committed to the UI repo.
      • The page should be a styled HTML doc with the same look and feel as the rest of the app. Could be something that renders the markdown to HTML at build time as a static file and served out of the nodejs server, or could be rendered dynamically and a route in the React app. Will leave implementation decision and pro/con up to implementer.
      • We should have the ability to link to anchors in this doc when abnormal event conditions are observed on CRs (see MIG-521 for more info about these conditions).

              ibolton@redhat.com Ian Bolton
              ernelson@redhat.com Erik Nelson (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: