Documentation office hours - July 2022

2022-07-01T02:00:00Z

2022-07-01 (Asia)

Attendees

  • Mark Waite
  • Meg McRoberts
  • Dheeraj Singh Jodha

Recording:

Agenda:

2022-07-07T17:00:00Z

2022-07-07 (Europe)

Attendees

  • Kevin Martens
  • Vihaan Thora
  • Bruno Verachten
  • Mark Waite

Recording:

Agenda:

  • Action items

    • Mark - Archive docs mailing list, switch to community.jenkins.io for Docs SIG
    • Upcoming blog posts that Mark owes to the organization
      • Award winners from cdCon
        • Darin Pope named CDF Continuous Enthusiast of 2022
        • Basil Crow named Jenkins Top Contributor
        • Wadeck Follonier Security MVP (Most Valuable Player)
        • Oleg Nenashev named CDF Top Documentor
      • Jenkins Contributor Summit summary
      • She Code Africa Contributhon results
  • News

    • 2.358 released this week and requires Java 11 or Java 17
      • No longer supports Java 8
    • Next LTS baseline will drop Java 8 support (September)
      • Additional context added to documentation
  • Jenkins 2.346.2 changelog and upgrade guide

    • Mark and Kevin submitted the content
    • First reviews received, updates applied
  • Google Summer of Code update - Vihaan Thora

    • Non-scrolling contents list on side panel
    • Data type inline with parameter name
    • Search on the Pipeline steps reference page
    • Release of the pipeline library, artifact is visible on repo.jenkins-ci.org
      • Considering if it should be made incremental
      • Will replace the relevant classes in pipeline steps generator with a reference to the library
      • Consider adding automated tests in the future
  • Require Java 11 further improvements - Jenkins 2.358, Jenkins 2.359, …

    • Jetty upgrade from 9.x to 10.x
      • More complicated because incompatible changes in Websocket API between Jetty 9.x and Jetty 10.x
    • Java 11 language extensions being applied
      • OpenRewrite prototype by Steve Hill may help with plugin modernization
  • Commercial support page proposal

    • Suggested by Gavin Mogan of the Jenkins governance board
    • Update support page to provide better content/direct contact to support
  • Look & feel updates for www.jenkins.io

2022-07-08T02:00:00Z

2022-07-08 (Asia)

Attendees

  • Mark Waite
  • Meg McRoberts
  • Kristin Whetstone

Recording:

Agenda:

  • Action items
    • Mark - Archive docs mailing list, switch to community.jenkins.io for Docs SIG
    • Upcoming blog posts that Mark owes to the organization
      • Award winners from cdCon
        • Darin Pope named CDF Continuous Enthusiast of 2022
        • Basil Crow named Jenkins Top Contributor
        • Wadeck Follonier Security MVP (Most Valuable Player)
        • Oleg Nenashev named CDF Top Documentor
      • Jenkins Contributor Summit summary
      • She Code Africa Contributhon results
  • News
    • 2.358 released this week and requires Java 11 or Java 17
      • No longer supports Java 8
    • Next LTS baseline will require Java 11
  • Jenkins 2.346.2 changelog and upgrade guide
    • Submitted, refinements proposed and merged
  • Google Summer of Code update - Mark Waite
    • Non-scrolling contents list on side panel
    • Data type inline with parameter name
    • Search on the Pipeline steps reference page
    • Release of the pipeline library, artifact is visible on repo.jenkins-ci.org
      • Considering if it should be made incremental
      • Will replace the relevant classes in pipeline steps generator with a reference to the library
      • Consider adding automated tests in the future
      • Considering it for reuse with the REST API generator (in the future)
        • Use it for other cases that need to load plugins into Jenkins
  • Long-standing pull requests
    • Adopt a plugin
    • Meg’s security docs rework
  • Modernizing a plugin
    • OpenRewrite used by Steve Hill to automate some code improvement
    • Hope that in the future the modernization steps can be automated so the submitter does the testing and evaluation, while the tool makes the code changes

2022-07-14T18:00:00Z

2022-07-14 (Europe)

Attendees

  • Kevin Martens
  • Vihaan Thora
  • Bruno Verachten
  • Mark Waite

Recording:

Agenda:

  • Action items
    • Mark - Archive docs mailing list, switch to community.jenkins.io for Docs SIG
    • Upcoming blog posts that Mark owes to the organization
      • Award winners from cdCon
        • Darin Pope named CDF Continuous Enthusiast of 2022
        • Basil Crow named Jenkins Top Contributor
        • Wadeck Follonier Security MVP (Most Valuable Player)
        • Oleg Nenashev named CDF Top Documentor
      • Jenkins Contributor Summit summary
      • She Code Africa Contributhon results
  • News
    • 2.346.2 released - Replaced install-plugins.sh with pointer to plugin installation manager
    • 2.359 released - More Java 11, preparing for Jetty 9 to Jetty 10 transition
    • DevOps World is coming
      • Jenkins Contributor Summit
  • Google Summer of Code update - Vihaan Thora
    • Pipeline library extraction is in progress
    • Tests have been added
    • Needs review from Kristin
    • Preparing for next week’s Jenkins Online Meetup
  • Commercial support page proposal
    • Prototype shown by Gavin
    • Update support page to provide better content/direct contact to support
  • Look & feel updates for www.jenkins.io
    • Changes to navbar, banner, footers, carousel
    • Existing reviews/suggestions (recent font change, current messaging vs background image, accessibility)
      • Responses to feedback in the comment
    • Mark wants the “Jumbotron” to be “above the fold” on most monitors
    • Need to check with Gavin Mogan on the impact on plugins site
    • Need to decide if impact on the Chinese language site is a concern
  • Preparing for Jenkins 2.346.3 LTS
    • Changelog and upgrade guide needed
    • August 10, 2022 scheduled release date
    • On July 28th 2022, review changelog & upgrade guide
  • Require Java 11 is coming to LTS in September
    • We’ll need a changelog and an upgrade guide

2022-07-15T02:00:00Z

2022-07-15 (Asia)

Attendees

  • Mark Waite
  • Meg McRoberts
  • Kristin Whetstone

Recording:

Agenda:

  • Action items
    • Mark - Archive docs mailing list, switch to community.jenkins.io for Docs SIG
    • Upcoming blog posts that Mark owes to the organization
      • Award winners from cdCon
        • Darin Pope named CDF Continuous Enthusiast of 2022
        • Basil Crow named Jenkins Top Contributor
        • Wadeck Follonier Security MVP (Most Valuable Player)
        • Oleg Nenashev named CDF Top Documentor
      • Jenkins Contributor Summit summary
      • She Code Africa Contributhon results
  • News
    • 2.346.2 LTS released this week
      • Requires Java 11 or Java 17
    • 2.359 released this week - requires Java 11 or Java 17
    • Next LTS baseline will require Java 11
      • Supports Java 17
    • May need to cancel July 28 meeting
      • Mark attending Southern California Linux Expo (SCaLE 19x)
      • Kohsuke Kawaguchi attending as well, along with Alyssa Tong
  • Jenkins 2.346.3 changelog and upgrade guide
    • Upgrade guide and changelog review July 28
    • August 10, 2022 release date
    • Submitted, refinements proposed and merged
  • Look and feel page improvements pull request
    • Needs further review by Gavin Mogan to assess impact on plugins.jenkins.io
    • Color of the teal “Documentation” button would look better with the blue color
  • Google Summer of Code update - Mark Waite
    • Pipeline Steps Doc Generator project preparing for July 21 Jenkins Online Meetup
      • Non-scrolling contents list on side panel
      • Data type inline with parameter name
      • Search on the Pipeline steps reference page
      • Release of the pipeline library, artifact is visible on repo.jenkins-ci.org
        • Considering if it should be made incremental
        • Will replace the relevant classes in pipeline steps generator with a reference to the library
        • Consider adding automated tests in the future
        • Considering it for reuse with the REST API generator (future project idea)
          • Use it for other cases that need to load plugins into Jenkins
    • Jenkinsfile Runner
    • Plugin health score system
    • Git cache maintenance
    • Jenkins Online Meetup
  • Long-standing pull requests
    • Modernizing a plugin
    • Meg’s security docs rework
  • Modernizing a plugin
    • Ran another test drive of the modernization steps
    • OpenRewrite used by Steve Hill to automate some code improvements
    • Hope that in the future the modernization steps can be automated so the submitter does the testing and evaluation, while the tool makes the code changes

2022-07-21T18:00:00Z

2022-07-21 (Europe) - Look & feel, Blue Ocean, Commercial support

Attendees

  • Mark Waite
  • Bruno Verachten

Recording:

Agenda:

  • Action items
    • Mark - Archive docs mailing list, switch to community.jenkins.io for Docs SIG
    • Upcoming blog posts that Mark owes to the organization
      • Award winners from cdCon
        • Darin Pope named CDF Continuous Enthusiast of 2022
        • Basil Crow named Jenkins Top Contributor
        • Wadeck Follonier Security MVP (Most Valuable Player)
        • Oleg Nenashev named CDF Top Documentor
      • Jenkins Contributor Summit summary
      • She Code Africa Contributhon results
  • News
    • Jenkins 2.360 released
      • New configuration page for Freestyle projects and other projects
        • Moves the navigation to the side panel from the top
        • Folders plugin does not have the change
        • UX SIG includes a demo
    • Google Summer of Code presentations today
      • Pipeline Steps Doc Generator - Vihaan Thora
  • Look and feel page improvements pull request
    • Looks ready to go
    • Need to coordinate the merge with Gavin Mogan so that we don’t disrupt the plugin site
      • Open for more feedback through a community.jenkins.io post?
      • Yes, and coordinate with Gavin on the final merge (Mark do it)
  • Blue ocean status message to embed in Blue Ocean docs pages
    • Pull request 5288
    • Sample site page
      • Placement of the message on the page?
      • Prefer it higher on the page, possibly after the very first paragraph
        • Create a strong first paragraph if one does not already exist
  • Search improvements for www.jenkins.io
    • Some searches on www.jenkins.io have very poor results
      • Search for “upgrade”
    • Our use of Docusearch by Algolia needs to upgrade from the legacy scraper
      • Need some time to follow their directions, reconfigure the site to use new format
      • Any way to evaluate the change from legacy scraper to new system
        • Valid question
      • Mark to create a jenkins.io issue for this upgrade
        • Track progress in the GitHub issue
  • Other topics
    • Next LTS baseline will require Java 11
      • Baseline will be chosen next week, likely either 2.360 or 2.361
      • Supports Java 17
    • May need to cancel July 28 meeting
      • Mark attending Southern California Linux Expo (SCaLE 19x)
      • Kohsuke Kawaguchi attending as well, along with Alyssa Tong
      • Mark to cancel the meeting next week
  • Commercial support page proposal
    • Prototype shown by Gavin
    • Update support page to provide better content/direct contact to support
    • Mark submitted an additional data item for another vendor
    • Need more data from vendors for the prototype
      • May want to ask the Outreach SIG to contact potential vendors
    • Discuss further adding cloud providers to the commercial vendors
      • They are not commercial support vendors, but are commercial vendors
      • Raise the question to the community forum, discuss there
  • Changelog entries from multiple repositories - Mark Waite
    • Weekly changelogs are generated by a script that creates entries from core pull requests
    • Packaging repository can provide important changes (like PR-325 support Java 17 in Windows installer)
    • Docker controller repository sometimes contributes important changes (like PR-1408 Replace install-plugins.sh)
    • Could we enhance the changelog generator to read the pull requests from packaging repository and from the Docker controller repository?
      • If we did, how would the changelog generator know which pull requests to include?
    • Mark ask the Jenkins developer list as a discussion topic
  • Jenkins 2.346.3 changelog and upgrade guide

No need to coordinate with me. The fix for plugin site is already merged (stories needs it too, but I’m working on a shared library for all of them, and stories doesn’t get re-generated). you can close/reopen DONT MERGE - Test out pr by halkeye · Pull Request #1210 · jenkins-infra/plugin-site · GitHub if you have any concerns.

Did they drop me from the replies? I can look into it more I just have no details

Not as far as I know. The most recent reply said:

I interpret that to mean that we’re fortunate that search works at all on www.jenkins.io, since they’ve moved to a new way of indexing the pages. I assume we somehow need to open the Algolia project BH4D9OD16A and reconfigure it per their instructions. Unfortunately, that is more than I can do right now. If you’re available and have permissions, that would be wonderful.

Yea I didn’t get that response, which is wired cause I started the thread. I’ll see what I can do.

2022-07-22T02:00:00Z

2022-07-22 (Asia) - GSoC, Look & Feel, Blue ocean status

Attendees

  • Mark Waite
  • Meg McRoberts
  • Kristin Whetstone

Recording:

Agenda:

  • Action items
    • Mark - Archive docs mailing list, switch to community.jenkins.io for Docs SIG
    • Upcoming blog posts that Mark owes to the organization
      • Award winners from cdCon
        • Darin Pope named CDF Continuous Enthusiast of 2022
        • Basil Crow named Jenkins Top Contributor
        • Wadeck Follonier Security MVP (Most Valuable Player)
        • Oleg Nenashev named CDF Top Documentor
      • Jenkins Contributor Summit summary
      • She Code Africa Contributhon results
  • News
    • May need to cancel July 29 meeting
      • Mark attending Southern California Linux Expo (SCaLE 19x)
      • Mark to cancel in the calendar
  • Google Summer of Code update - Kristin Whetstone
    • July 21 Jenkins Online Meetup recording
    • At the midpoint of GSoC project
    • Online meetup including presentations from all contributors
    • Docs web site improvements
      • Static scroll bar - easier to navigate
      • Search in the pipeline steps
      • Additional feedback is welcomed and encouraged
    • Upgrades to the generator
    • What’s next?
      • Improving the very large pages (like step and checkout)
      • Phase 1 completed successfully
      • Phase 2 planning in progress
      • Attend the Europe office hours for latest progress reports
        • No issue that no Docs office hours next week
      • See the Gitter docs channel, suggestions encouraged there
        • Possible wireframe layouts coming
      • Very successful that the Docs SIG has been here to cheer
  • Look and feel page improvements pull request
  • Jenkins 2.346.3 changelog and upgrade guide
    • Request for release lead volunteer has been sent
    • Upgrade guide and changelog review July 28
      • Kevin and Mark create the draft next week
      • Review async (look at the pull request)
    • August 10, 2022 release date
    • Submitted, refinements proposed and merged
  • Long-standing pull requests
    • Modernizing a plugin
    • 2 hour session at DevOps World on Adopting a plugin
      • Mark, Jean-Marc, Bruno Verachten
        • Adopt ~30 plugins, modernize them, hide the modernization
        • Students in a workshop modernize them, look in the “back of the book” for answers when they hit a problem
        • Merge the students work
        • Goal: each student merge at least one pull in the two hours of workshop
        • Use Gitpod to create and delete development environment
          • Automatic creation of good development environments
          • (Correct Java, Maven, etc.)
          • Let’s them run Jenkins without ever putting it on their computer
        • On location workshop in Orlando, FL
        • Use the tutorial pages, must be published and usable by then
    • Meg’s security docs rework
  • Look at Jenkins pull requests
    • Blue Ocean status in the pages
      • Meg suggested that we use three different types of admonitions
        • Full admonition on the opening section (no enhancements, visualization alternatives, pipeline creation alternatives, refer to Pipeline syntax snippet generator)
        • VIsualization admonition on sections focused on visualization (no enhancements, visualization alternatives)
        • Pipeline creation admonition on sections focused on creation (no enhancements, pipeline creation alternatives, refer to Pipeline syntax snippet generator)