Documentation office hours - May 15, 2025

Community
,
1

2025-05-15

Attendees:

  • Kevin Martens
  • Birajit Saikia
  • Bruno Verachten
  • Kris Stern
  • Mark Waite
  • Meg McRoberts

Agenda

  • Contributor spotlight
    • Latest spotlight, featuring Sacha Labourey, published
      • Ilan Rabinovitch for May spotlight
      • Meg McRoberts shared her response for a future spotlight
      • Spotlights to be published once per month
  • Documentation fixes implemented
    • Added Java 21 upgrade instructions as they were absent
    • Updated all installation guides (as needed) for Java 21
    • Updated Jenkinsfile runner tutorial for Java 21
    • Updated Docker tutorial partial for Java 21
    • Only remaining mentions of Java 17 are historical (blog posts, older changelogs, etc)
    • Compiling all areas changed for Java 21 for eventual update to Java 25
  • Java 25 documentation
    • Thanks to Kris Stern for creating this issue
    • Kevin creating list of areas that will need Java 25 update when it is available
    • Java 21 updates have helped spotlight areas that will need to be updated
  • 2025 Jenkins Community awards
    • Updated blog post for voting period
    • Carousel updated as well
    • 3 Categories:
      • Most Valuable Contributor
      • Most Valuable Advocate
      • Security MVP
    • Voting open until Jun 16, 2025
      • Extended voting period
    • Winners will be announced at cdCon 2025 (June 23 - 25 2025)
  • Revamped Pipeline Visualization by Jan Faracik
    • Highlights and reviews the updates to Pipeline Graph View
    • Examples of it in Jenkins
  • Google Summer of Code 2025 - Kris Stern
    • 5 projects selected - congratulations and looking forward to the program!
    • Thanks to everyone who submitted a proposal
    • 160+ valid proposals submitted and reviewed
    • Confirmed contributors announced on May 8th by Google
  • Chinese documentation site and Chinese localization plugin
    • Planned to retire it, but there are 58,000 installations of the Chinese localization plugin
    • Runxia Ye and Mark discussed at FOSDEM
      • Check the actual usage of the Chinese with analytics
      • Check the actual usage of Chinese localization
    • Alternative would be to find a funding source to translate latest messages to Chinese
      • Kris has created a new issue to initiate adding native Chinese (both traditional and simplified) localization to Jenkins core natively
      • The localization is planned to start sometime Summer 2025
    • Kris recently adopted the Chinese docs site
      • Modernization and updates will happen along with localization efforts
    • Are the Jenkins users already English speakers and don’t need Chinese localization?
    • Potentially include Chinese localization in core and deprecate/disable plugin once it is complete
    • Not enough data to determine one way or another just yet
  • LTS and Weekly releases
  • Recent work
  • Alpha Omega idea - improving open source security for Jenkins users - Mark Waite
    • Further discussions had at Jenkins Contributor Summit - 31 Jan 2025
    • Not expecting any additional projects yet, but Wadeck is working with them periodically
      • Not right now, but maybe later
  • Plugin Developer documentation
    • Topic brought by Antoine Neveux at previous office hours
    • Lots of warning signs in the documentation saying “work in progress”
    • How can this be updated/enhanced and provide a more confident experience
    • What would be the best way to address this?
      • Improve a plugin tutorial helps, but does not address the developer documentation directly
  • Blue Ocean Deprecation
    • Work to remove Blue Ocean from documentation has begun
    • Tutorials moved towards bottom of page and includes status note
    • Status notes have been updated to indicate alternatives/replacements for pipeline visualization.
  • Google Season of Docs program is closed - Mark Waite
    • Announced in a Google Group
      • The 84 Google Season of Docs case studies (and the final project reports from the 2019-2020 seasons) will continue to be accessible on the program website. Additional materials, including a documentation maturity audit tool and guidance for working with technical writers, are available in the Open Docs Repo on GitHub.
        We’re also excited to release two new resources based on analysis of the Google Season of Docs case studies: a set of new documentation project archetypes to help open source maintainers identify and scope typical projects and (coming soon) a guide to running documentation projects for open source maintainers. More information will be announced via the Google Open Source Blog.
    • Six years of Google Season of Docs - Jenkins participated in one year of Season of Docs (Kubernetes docs)
    • Kevin to update the Google season of docs page to indicate that it has ended, as well as Documentation SIG page.
  • Screenshot updates/review for July LTS
    • New header in July LTS baseline
    • Need some screenshots