search

jenkins-infra / jenkins.io

A static site for the Jenkins automation server
https://jenkins.io
Other
326 stars 1.25k forks source link

Pipeline: SCM Step page - GitSCM docs require an extra click #6010

Open kwilson33 opened 1 year ago

kwilson33 commented 1 year ago

Problem with the Pipeline: SCM Step page

The page is missing the dropdown menu for the GitSCM class. A few months ago from today (2/7/23) I remember there being one, showing all of the options. Now, there is just an 'scmGit' drop-down that is empty.

Screenshots

image Empty 'scmGit' dropdown

Possible Solution

Add documentation for the scmGit/GitSCM class.

N/A

MarkEWaite commented 1 year ago

The scmGit page has been deduplicated from the many, many locations where it was inserted and placed in its own page. That dramatically improved page load time and made the pages much more usable. It also changed the interaction with that link. It now requires a two step process to reach the scmGit documentation.

When the page first opens, that region looks like this:

scmGit-01-initial-presentation

  1. Click the "+" to the left as scmGit as though you were expanding it. The word scmGit is then converted from a text string into a hyperlink. That results in something that looks like this:

scmGit-03-after-clicking-plus-sign-with-hyperlink

  1. Click the scmGit hyperlink to navigate to the scmGit page. That opens a page that has this:

scmGit-04-after-cllicking-hyperlink

I'm sure that there is more that can be done to improve the navigation beyond the current two step process. The page load time performance from the GSoC 2022 project were so significant that we accepted this additional step in order to read the scmGit page.

kwilson33 commented 1 year ago

Oh wow I don't know how I didn't realize that there was a hyperlink, thanks! My main issue was that I couldn't find the scmGit documentation, so now that I can view it, I'm relieved. Though, I do agree that the 2 step process could probably be improved.

MarkEWaite commented 1 year ago

I'd love to have someone improve that interaction, but I'm not the person to do it. No JavaScript skills and no real interest in developing them.

kwilson33 commented 1 year ago

Understood. Not a big deal 😊.

Related question, and I think you'd be able to help. What is the most up to date page on GitSCM/scmGit?

I see there are these 2 pages

Both have similar content, and I believe are documenting the same functionality.

Maybe this should be opened up in another issue?

MarkEWaite commented 1 year ago

Both have similar content, and I believe are documenting the same functionality.

https://www.jenkins.io/doc/pipeline/steps/params/scmgit/ is the most current page.

Already opened as an issue in:

lemeurherve commented 1 year ago

Since #6677 these outdated pages return (for now at least) a 403 error, see https://github.com/jenkins-infra/helpdesk/issues/3360#issuecomment-1790809338