Include the plugin steps in plugin site

[timja]

Now that @zbynek added the Pipeline step reference to jenkins.io

It would be great to think about including the steps directly on the plugin site rather than linking off to a different site

[zbynek]

@timja are you sure aout this? I'd like to avoid having the same content on two URLs. I also think it makes sense to have the pipeline step reference together with the pipeline syntax reference on jenkins.io.

@kwhetstone @MarkEWaite what do you think?

[MarkEWaite]

I would love to have a tab on each plugin page that lists the Pipeline steps provided by that plugin. I've become more and more a user of the plugins page as it gets more and more useful content.

I don't want to lose the Pipeline steps reference on www.jenkins.io, but I would not object if the pipeline step reference were also available on the plugins.jenkins.io page for the specific plugin.

In the case of the git plugin, there are really two pages that provide the Pipeline steps reference for the plugin. The plugin specific page currently linked from the right side of the plugins.jenkins.io page and the git specific portion of the SCM checkout step . The second page is the more useful of the two pages and is the recommended form.

I'm not sure how plugins.jenkins.io would present those two different sets of information. I wonder if we should find a way to include the git specific checkout scm information in the plugin specific page.

[zbynek]

I wonder if we should find a way to include the git specific checkout scm information in the plugin specific page.

I think that's part of https://issues.jenkins.io/browse/WEBSITE-809 that @vihaanthora is working on for his GSoC project.

[vihaanthora]

After jenkins-infra/pipeline-steps-doc-generator#203 gets merged and we add some suitable parameter class names in the configuration file, the steps for the specific plugins (like class: 'GitSCM') would be shifted to new links. We can then link these pages (the link should stay static) to the plugin site suitably. I think this would help in solving the required task without bringing any redundant content.
The only foreseeable problem with this approach could be that we are unable to add the class names that have different documentation at different places (like Bitbucket Server) to the configuration file, and hence, a general page for them could not be created using the processing program.
Anything that you would like to add @kwhetstone?

[zbynek]

@MarkEWaite @timja so the idea here would be to have just a list of steps in the tab and link each of them to the step reference at jenkins.io?

[MarkEWaite]

@MarkEWaite @timja so the idea here would be to have just a list of steps in the tab and link each of them to the step reference at jenkins.io?

A tab on the plugins site with a list of the Pipeline steps provided by that plugin and links to the documentation for that step on www.jenkins.io would be great for me.

I would not object to having the documentation for the steps duplicated in that tab as well, but a link to the steps would already be an improvement. The checkout step on www.jenkins.io is difficult to use because it presents all implementations of checkout, whether or not they are installed in your controller. The tab for each plugin would show only the steps implemented by that plugin, so would be easier to navigate.

If users would read the help in their own controller, they would get the same benefit, but Google search does not direct them to their own controller.