Add generated Jenkins inline help pages

[daniel-beck]

trafficstars

Many of them are not particularly useful outside the context of Jenkins, but for those it works for it's a lot nicer than linking to files within the GitHub repository.

Thoughts?

Screenshots

[MarkEWaite]

It looks like the Jenkins core war file is extracted to get the help from core. I assume the same technique would be used for each of the plugins, then their content would be placed in a directory structure that includes the plugin artifact ID in the path to the individual files.

Have I understood correctly?

How would the URL references be formatter to refer to a specific help file? Would there be additional hierarchy for the help fields based on their location in the plugin jar file? Can we use that location to group multiple help entries for a single item.

For example, the git plugin has 163 HTML files, as a sample they look like this:

hudson/plugins/git/browser/GogsGit/help-repoUrl.html
hudson/plugins/git/browser/GitLab/help-repoUrl.html
hudson/plugins/git/browser/GitLab/help-version.html
hudson/plugins/git/BranchSpec/help-name_ja.html
hudson/plugins/git/BranchSpec/help-name.html
hudson/plugins/git/ChangelogToBranchOptions/help-compareRemote.html
hudson/plugins/git/ChangelogToBranchOptions/help-compareTarget.html
hudson/plugins/git/ChangelogToBranchOptions/help-compareTarget_ja.html
hudson/plugins/git/ChangelogToBranchOptions/help-compareRemote_ja.html
hudson/plugins/git/UserRemoteConfig/help-refspec.html
hudson/plugins/git/UserRemoteConfig/help-refspec_ja.html
hudson/plugins/git/UserRemoteConfig/help-name_ja.html
hudson/plugins/git/UserRemoteConfig/help-name.html
hudson/plugins/git/UserRemoteConfig/help-url.html
hudson/plugins/git/UserRemoteConfig/help-credentialsId.html
hudson/plugins/git/UserRemoteConfig/help-url_ja.html
hudson/plugins/git/GitSCM/help-choosingStrategy.html
hudson/plugins/git/GitSCM/help-globalConfigName.html
hudson/plugins/git/GitSCM/help-createAccountBasedOnEmail.html
hudson/plugins/git/GitSCM/help-userRemoteConfigs.html
hudson/plugins/git/GitSCM/help-hideCredentials.html
hudson/plugins/git/GitSCM/help-userRemoteConfigs_ja.html
hudson/plugins/git/GitSCM/help-showEntireCommitSummaryInChanges.html
hudson/plugins/git/GitSCM/help-globalConfigEmail.html
hudson/plugins/git/GitSCM/help-gitTool.html
hudson/plugins/git/GitSCM/help-defaultClientType.html
hudson/plugins/git/GitSCM/help-createAccountBasedOnEmail_ja.html
hudson/plugins/git/GitSCM/help-allowSecondFetch.html
hudson/plugins/git/GitSCM/help-globalConfigName_ja.html
hudson/plugins/git/GitSCM/help-globalConfigEmail_ja.html
hudson/plugins/git/GitSCM/help-useExistingAccountWithSameEmail.html

I guessed that would mean "GitSCM" might be a dedicated page with 15 segments on the page, while GoGS would have 1 and GitLab would have 2.

I like the idea of placing it inside jenkins.io more than making it a separate service because I'd rather not have another location to maintain and another location to add to the content delivery network. However, I'm also open to something like https://online-help.jenkins.io/ as a lop level URL.

[daniel-beck]

For example, the git plugin has 163 HTML files, as a sample they look like this:

…
hudson/plugins/git/BranchSpec/help-name_ja.html
hudson/plugins/git/BranchSpec/help-name.html

This code specifically filters out non-English content.

[daniel-beck]

Not having this, I ended up just copying all of https://github.com/jenkinsci/jenkins/blob/master/core/src/main/resources/jenkins/security/ResourceDomainConfiguration/help-url.html to https://www.jenkins.io/doc/book/security/user-content/#resource-root-url in https://github.com/jenkins-infra/jenkins.io/pull/4312

[github-actions[bot]]

Please take a moment and address the merge conflicts of your pull request. Thanks!

[kmartens27]

Hi @daniel-beck, is this something that is still being developed, or would it be okay to move this content into a new Issue so that another person could iterate from this?

[daniel-beck]

@kmartens27 It's unclear what you're asking. Other than fairly straightforward merge conflict resolution, what actions do you expect of me here?

[kmartens27]

Hi @daniel-beck, sorry for not being more clear! I was asking to see if there was any further work that needed to be done on this, or if it is just waiting to be merged. There hadn't been any updates since May 2021, and we've been looking at older pull requests that have been marked as "stalled" to try and determine whether they are still being actively worked on, or if they have been abandoned. Would any other actions, besides the merge conflicts, need to be performed?

[daniel-beck]

Would any other actions, besides the merge conflicts, need to be performed?

There has not been consensus that this PR is a good idea, but neither has it been rejected.