Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-54783

Library additions to Global Variable Reference are not displayed formatted

    Details

    • Similar Issues:

      Description

      vars/myStep.txt is included correctly (after a successful build) in the Global Variables Reference.

      However, it doesn't matter if it has a MD format or a HTML format, it gets displayed as plain text, not rendered.

        Attachments

          Activity

          Hide
          fnasser Fernando Nasser added a comment - - edited

          OK, this seems to be a documentation issue.

          For HTML rendering this plugin must be installed: OWASP Markup Formatter Plugin ("Safe HTML" formatter) https://wiki.jenkins.io/pages/viewpage.action?pageId=71436291

          If you want Markdown as well, this one: https://wiki.jenkins.io/display/JENKINS/PegDown+Formatter+Plugin#PegDownFormatterPlugin-install
          (maybe needs to leave the option "suppress all HTML off)

          Can someone add a note where the documentation talks about the global variables .txt files please?

          Not sure how to change this issue to a "Documentation" one.

          Show
          fnasser Fernando Nasser added a comment - - edited OK, this seems to be a documentation issue. For HTML rendering this plugin must be installed: OWASP Markup Formatter Plugin ("Safe HTML" formatter) https://wiki.jenkins.io/pages/viewpage.action?pageId=71436291 If you want Markdown as well, this one: https://wiki.jenkins.io/display/JENKINS/PegDown+Formatter+Plugin#PegDownFormatterPlugin-install (maybe needs to leave the option "suppress all HTML off) Can someone add a note where the documentation talks about the global variables .txt files please? Not sure how to change this issue to a "Documentation" one.
          Hide
          reinholdfuereder Reinhold Füreder added a comment -

          In https://jenkins.io/doc/book/pipeline/shared-libraries/ "Directory structure":

          The matching .txt, if present, can contain documentation, processed through the system’s configured markup formatter (so may really be HTML, Markdown, etc., though the .txt extension is required). This documentation will only be visible on the Global Variable Reference pages that are accessed from the navigation sidebar of Pipeline jobs that import the shared library. In addition, those jobs must run successfully once before the shared library documentation will be generated.

          => So it is not too bad anymore?

          Show
          reinholdfuereder Reinhold Füreder added a comment - In https://jenkins.io/doc/book/pipeline/shared-libraries/ "Directory structure": The matching .txt, if present, can contain documentation, processed through the system’s configured markup formatter (so may really be HTML, Markdown, etc., though the .txt extension is required). This documentation will only be visible on the Global Variable Reference pages that are accessed from the navigation sidebar of Pipeline jobs that import the shared library. In addition, those jobs must run successfully once before the shared library documentation will be generated. => So it is not too bad anymore?
          Hide
          cmamigonian Camden Mamigonian added a comment -

          Is there a plan to address this?  If it's a doc update what should the doc say?  The Markdown plugin mentioned above is old and doesn't seem to be safe to use.  Ideally Jenkins would be able to render Markdown here natively instead of needing another plugin to do it.

          Show
          cmamigonian Camden Mamigonian added a comment - Is there a plan to address this?  If it's a doc update what should the doc say?  The Markdown plugin mentioned above is old and doesn't seem to be safe to use.  Ideally Jenkins would be able to render Markdown here natively instead of needing another plugin to do it.
          Hide
          reinholdfuereder Reinhold Füreder added a comment -

          I think the Markdown formatting is (or can be) done via the "OWASP Markup Formatter" plugin (https://plugins.jenkins.io/antisamy-markup-formatter/" and is neither old, nor unsafe.

          The only issue I currently suffer from with respect to the formatting in "Global Variables Reference" is JENKINS-61757 (this used to work and I am pretty sure also when this issue was filed).

          Show
          reinholdfuereder Reinhold Füreder added a comment - I think the Markdown formatting is (or can be) done via the "OWASP Markup Formatter" plugin ( https://plugins.jenkins.io/antisamy-markup-formatter/ " and is neither old, nor unsafe. The only issue I currently suffer from with respect to the formatting in "Global Variables Reference" is JENKINS-61757 (this used to work and I am pretty sure also when this issue was filed).

            People

            • Assignee:
              Unassigned
              Reporter:
              fnasser Fernando Nasser
            • Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated: