Uploaded image for project: 'Hadoop HDFS'
  1. Hadoop HDFS
  2. HDFS-7240 Scaling HDFS
  3. HDFS-12661

Ozone: Support optional documentation link in KSM/SCM webui

    XMLWordPrintableJSON

Details

    • Sub-task
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • HDFS-7240
    • HDFS-7240
    • ozone
    • None
    • Reviewed

    Description

      In some cases it could be useful to include additional documentation to the SCM/KSM web ui.

      This patch includes an optional hook. During the startup scm/ksm web ui do a HTTP HEAD request and if docs/index.html exists, an additional Documentation link will be displayed in the menu header.

      Long term we can generate documentation automatically from the source.

      Testing:

      Do a full build, start scm: no link in the ui.

      Add some optional documentation (choose one):

      • hadoop-hdfs-project/hadoop-hdfs/src/main/webapps/scm/docs/index.html (before build)
      • hadoop-hdfs-project/hadoop-hdfs/target/webapps/scm/docs/index.html (after clean, before build)
      • hadoop-dist/target/hadoop-3.1.0-SNAPSHOT/share/hadoop/hdfs/webapps/scm/docs/index.html (after build)

      And start scm again. There should be a documentation link in the menu which opens the optional documentation.

      Attachments

        1. HDFS-12661-HDFS-7240.001.patch
          2 kB
          Marton Elek
        2. HDFS-12661-HDFS-7240.002.patch
          1 kB
          Marton Elek

        Activity

          People

            elek Marton Elek
            elek Marton Elek
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: