[JIRA] (JENKINS-54783) Library additions to Global Variable Reference are not displayed formatted

[fnasser@redhat.com (JIRA)]

Fernando Nasser created an issue

Jenkins / JENKINS-54783 Library additions to Global Variable Reference are not displayed formatted Issue Type: Bug Assignee: Unassigned Components: pipeline Created: 2018-11-22 20:33 Priority: Minor Reporter: Fernando Nasser 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. Add Comment

This message was sent by Atlassian Jira (v7.11.2#711002-sha1:fdc329d)

[fnasser@redhat.com (JIRA)]

Fernando Nasser commented on JENKINS-54783

Re: Library additions to Global Variable Reference are not displayed formatted OK, this seems to be a documentation issue. For HTML rendering this plugin must be installed: 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.

Add Comment

[fnasser@redhat.com (JIRA)]

Fernando Nasser edited a comment on JENKINS-54783

Re: Library additions to Global Variable Reference are not displayed formatted

OK, this seems to be a documentation issue.

For HTML rendering this plugin must be installed:   O WASP 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.

Add Comment

[fnasser@redhat.com (JIRA)]

Fernando Nasser edited a comment on JENKINS-54783

Re: Library additions to Global Variable Reference are not displayed formatted

OK, this seems to be a documentation issue.

For HTML rendering this plugin must be installed:   O WASP   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.

Add Comment

[vivek.pandey@gmail.com (JIRA)]

Vivek Pandey updated an issue

Jenkins / JENKINS-54783

Library additions to Global Variable Reference are not displayed formatted

Change By: Vivek Pandey Labels: documentation triaged-2018-11

Add Comment

[vivek.pandey@gmail.com (JIRA)]

Vivek Pandey updated an issue

Jenkins / JENKINS-54783 Library additions to Global Variable Reference are not displayed formatted Change By: Vivek Pandey Labels: documentation

Add Comment

[r.fuereder@xortex.com (JIRA)]

Reinhold Füreder commented on JENKINS-54783

Re: Library additions to Global Variable Reference are not displayed formatted 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?

Add Comment

This message was sent by Atlassian Jira (v7.13.12#713012-sha1:6e07c38)