Documentation office hours - Jan 24, 2022

2022-01-25T02:00:00Z

  • News

    • Plugins suspended from distribution
      • JRuby based - don’t run on Java 11 (last release was over 5 years ago)
      • Jython based - only 1 plugin
    • LTS baseline selection this week (Wednesday) for March 2022 LTS
      • 2.331 or 2.332 most likely
      • More UI changes - see the UX SIG recording
      • Some UI fixes may need to be backported
      • Docs update review and checks for outdated screenshots
        • She Code Africa project to review docs for outdated screenshots?
      • Mark create a “good first issue” to review docs for outdated images
        • Use the weekly release to prepare for March LTS
  • Open PRs

    • https://github.com/jenkins-infra/jenkins.io/pull/4612
      • Making progress but a couple issues!
      • Index.adoc list is too long – perhaps this should be broad topics rather than a full list of contents for this chapter?
        • Action: Remove the descriptions of the individual fields on the “Configure Global Security” page from the list in index.adoc so that list is not so long. These topics still show in the left frame and the “Configure Global Security” page still has a comprehensive list of all fields.
      • Inclusion of “How Jenkins executes jobs” is jolting in “Background concepts”
        • Action: Split “How Jenkins executes jobs” into a separate page
        • Action: Rename “Background concepts” to “Security concepts”
      • Left frame TOC is too long but can we fix it?
        • Action: none at this time
      • Agent → Controller filter being removed from UI so shall I move the contents of that file into controller-isolation (“Distributed builds”)?
        • Action: Move the information about Agent → Controller security to controller-isolation and remove that file since this field no longer shows on the UI.
    • Add generated Jenkins inline help pages by daniel-beck · Pull Request #3406 · jenkins-infra/jenkins.io · GitHub – marked as chore. Looks like a design discussion with last remarks from July 2020 and May 2021.
      • This sort of functionality would be extremely useful for anyone who is assisting other users.
      • Current implementation covers Jenkins Core but does not include plugins and including plugins in the current structure could make the output so long as to be nearly useless.
      • Current implementation does not include links to the content itself for easy reference, which would also make it a convenient tool for reviewing the content of inline help.
      • Oleg suggested replacing this with a javadoc.jenkins.io-alike service which exposes help pages from Jenkins core and plugins
    • Action: Mark Waite to discuss Oleg’s idea with Daniel Beck et alia and decide on a course of action, which may be closing this PR and creating a new issue.
      Infrastructure issue tracking has moved from Jira to GitHub issues
    • Better fit for projects like Hacktoberfest
    • No account on jenkins.io required
    • Easier linking to other open source projects
  • Discussions on Java 8 end of life

    • Mark to write the JEP, due for first review this Friday at Platform SIG
    • Either June 2022 or Sep 2022 LTS release will drop Java 8 support
      • Java 11 only
      • Java 17 support in the future
    • Discussions on Internet Explorer 11 end of life
      • Official end of support is June 2022
      • Likely drop support even sooner than June 2022
      • Microsoft Edge will likely be made a tier 1 platform
  • Action items

  • Weekly changelog pull request

  • GSoC project ideas

    • Plugin health score
      • Asked in community.jenkins.io to understand the project in detail
      • Show users an indicator of the “health” of the plugin
        • Visible locations (Where?)
          • Plugins site
          • Jenkins plugin manager
        • Calculation of the score
        • Attributes used in the score (What?)
          • Extensible by others
        • How the attributes are used (How?)
        • How to deliver?
          • Through the Jenkins update center adding more data
          • Could be through a different service
      • Small prototype that uses a Google Sheet to extract data from sources
        • Gathers data from
          • Update center
          • Plugin repositories
        • Shows a “score” based on the extracted data
          • 1000+ plugins, some classified “green”, some “yellow”, some “red”
        • Jake Leon has the sheet (has some embedded credentials, not safe to share widely)
      • Historical view of the score?
    • Automated plugin improvement pull requests
      • Series of improvement steps that have been identified
      • Automatically apply those to plugins, build, and submit pull request
  • She Code Africa project ideas

    • People interested in project and product management
      • Should we invite someone to be a mentored project manager?
        • Publish the recordings
        • Define meeting agendas
        • Lead meetings
        • Track progress, detect cases where progress is not being made
      • Should we invite someone to be a mentored tester?
        • Interactive exploration of the product
  • Open PRs

  • https://github.com/jenkins-infra/jenkins.io/pull/2642 - It looks like Oleg filed a blocking comment that has been resolved. Meg did a bunch of word-smithing suggestions in November 2021, including some comments about broken links that are apparently no longer broken. We have merge conflicts but what would it take to get this merged?

1 Like