Documentation office hours - July 24, 2025

Community
,
1

2025-07-24

Attendees:

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

Agenda

  • Contributor spotlight
    • Latest spotlight, featuring Meg McRoberts, published
      • Discussed with Advocacy & Outreach about potential spotlights
        • Provided updated list of top contributors, Alyssa will follow up with people
        • Thanks to Bruno for providing the data!
      • Have received several responses from those asked, thanks to those who have submitted responses
      • Mentors from GSoC (Berviento, V Sreenias, Vihbav, Phillipp Glanz)
  • 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
    • Full Java 25 support planned for Fall ‘25
    • Java 25 early access now in use on ci.jenkins.io and available in agents
      • If you want to explore with Java 24, make sure to use latest
  • Redesigning Jenkins pt 2
    • Second blog post from Jan Faracik on redesigning Jenkins/UI updates for Jenkins
    • Highlights the changes to the UI brought with 2.516.1 & previous weekly releases
    • Shares link for the livestream that Jan & Darin Pope hosted
      • Kevin currently working on updating images in documentation to reflect updated UI
        • Tracking sheet for work done so far
        • Multiple PRs for updating submitted, still more to go
        • Removing unnecessary noise from screenshots (old Breadcrumb nav that is not relevant to the content, etc) is helpful if the rest of the UI is still correct
  • YourKit, JetBrains, and AWS sponsorship blog posts
    • Thanks to Alexander Brandes for writing these up and working with both parties.
    • Thanks to YourKit for providing free licenses for the YourKit Java Profiler
    • Thanks to JetBrains for providing free annual All products Pack subscriptions
      • For Jenkins core maintainers & active contributors
      • To request a license/access, reach out to Alex via his email (in his GitHub profile)
    • Thanks to AWS for their continued support and sponsorship of Jenkins
      • Crucial for Jenkins continued function, recent migration from Azure to AWS for ci.jenkins.io was important to ensure service is provided
  • Google Summer of Code 2025
  • 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 starting in summer 2025
      • Will need to have a meeting with Mark Waite to discuss details later when Mark will be free
      • Planning to happen in parallel to the GSoC jenkins.io retooling project, as we will need to match in terms of tech stack for the versioned docs capability, or have some variants of this.
      • May not use the exact same tooling as the docs.jenkins.io site, but will follow as much as possible what can be done. Propose to use Docusaurus – https://docusaurus.io/ for the revamped Chinese site.
      • Planning on starting later this month (July)
    • 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
  • Good first issues on Jenkins.io
    • Looking to restock the good first issues
    • A number of work in progress pages
    • Thanks to Meg for creating good first issues
  • Remove GSOD label
    • Multiple thoughts on this
    • Removing label from the actual repo, not any of the documentation or pages
  • LTS and Weekly releases
  • Recent work
  • New success story & adopter
  • Removing Java 11 upgrade instructions
  • 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.
  • LInux Foundation, scarf.sh and tracking documentation page reading
    • LF has a contract with scarf.sh
    • Would we (as a group) be okay with documentation reader tracking
      • Based on public data (nothing spooky or nefarious happening)
    • OK that Mark Waite submits a test pull request to the www.jenkins.io repository to test the idea
      • Mark then invite Docs SIG members to click the link so that we can confirm the tracking works
  • Wiki migration redirect instructions
    • Currently, developer docs instruct users to create a redirect for the content migrated
      • No instructions on how to actually create the redirect
      • Kevin partnering with Mark Waite & Damien Duportal on what the process involves and steps needed to create and test
      • Once there are multiple examples, instructions will be updated to include more direct steps/information.
      • Redirects do not account for URL variation so trying to figure out the best way to capture these and redirect as intended.
      • Kevin has created a couple redirects, but has found that if there are multiple URLs that contain the same string, it may confuse the redirect behavior
        • Had to pause for a bit to address updated header documentation/screenshots
  • Docs feedback thread from gitter