Include Pipeline steps help in user documentation

[MarkEWaite]

Include Pipeline steps help in user documentation

No need to limit the Pipeline steps help to only be visible in the Pipeline steps reference. Let's see if asciidoc include will work in this case.

Testing done

None. Will test GitHub rendering of the include after pull request is created.

Submitter checklist

• Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
• Ensure that the pull request title represents the desired changelog entry
• Please describe what you did
• Link to relevant issues in GitHub or Jira
• Link to relevant pull requests, esp. upstream and downstream changes
• Ensure you have provided tests - that demonstrates feature works or fixes the issue

[MarkEWaite]

It is a nice idea, but it won't work with GitHub adoc because include is not supported. Refer to:

• Asciidoctor: support include directives for other asciidoc files github/markup#1095

[timja]

No need to limit the Pipeline steps help to only be visible in the Pipeline steps reference. Let's see if asciidoc include will work in this case.

should be a lot clearer from the plugin site / more prominent I think that it is now.

[MarkEWaite]

should be a lot clearer from the plugin site / more prominent I think that it is now.

I think that the Pipeline steps link from the plugins site is a good step, but I was hoping to insert the Pipeline step help HTML files into the generated documentation page as well, so that the online help would be visible to more readers and I would be more likely to correct errors and inconsistencies in the online help.

There are other suggestions, like use another file to define the final documentation file and have that provide the final output. For example, I could create README.adoc and use asciidoctor to generate README.html, then point the <url> property in pom.xml to the HTML file. That would allow the Asciidoc include directive and all I'd need is a Maven build step to generate the final HTML file.

[timja]

Or we could make plugin steps a tab on the plugin site? Probably more visible there