Documentation office hours - February 20, 205

2025-02-20

Attendees:

  • Kris Stern
  • Mark Waite
  • Meg McRoberts
  • Kevin Martens
  • Bruno Verachten
  • Soham Juneja
  • Birajit
  • Pratik Mane

Agenda

  • Contributor spotlight for Kohsuke Kawaguchi published
    • Great to share Kohsuke’s background and stories about Jenkins
  • Documentation developer experience - Meg McRoberts
    • Initial documentation development setup was not working
      • Can’t build based on the instructions
      • Mark uses Docker CE (Docker Desktop for Ubuntu 22.04 - make run)
      • Kris uses a macOS with Docker (make run)
      • Meg is seeing many complaints about file permissions
    • Meg opened an issue to track it (record what others need to do)
      • Docker minimum version is much older than the version she has
  • Documentation fixes needed
  • Command palette blog post
  • Google Summer of Code - Kris Stern
    • New project ideas
      • Chatbot plugin inside Jenkins to answer user question
        • Mostly Jenkins resources/where to find, not necessarily how to do things in Jenkins
      • Improving Tekton Client Plugin for Jenkins
      • Kris plans to interview candidates to mentored projects
    • New potential mentors
      • V. Sreenivas
      • Vibhav Bobade
    • Completing versioned docs site/alternative build tools
      • Mentors would be Kris Stern and Kevin Martens (and maybe also Bruno)
    • Stories site retooling/rebuild/modernize (to some degree)
      • May want to standardize how the stories site is (compared to spotlight)
  • Chinese documentation site and Chinese localization plugin
    • Planned to retire it, but there are 58000 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 could draft a project idea to maintain the Simplified Chinese (mainland China)
      • Kris will create a new issue to initiate adding native Chinese (both traditional and simplified) localization to Jenkins core natively
    • 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 releases
  • Jenkins Contributor Summit
    • Very successful, lots of work in the breakout groups and discussions overall
    • Blog post recap to come from Mark Waite
  • Recent work
    • Thanks to Birajit for their recent work on updating the changelog archive, and many other efforts.
      • One very ambitious pull is to update the master branch of jenkins.io to main
        • Kevin testing and checking various sites/locations that could cause something to break
        • Submitted some updates to Birajit’s fork for things like links in the documentation, but this does not cover how other sites may interact with this sort of change
  • Alpha Omega documentation project idea - improving open source security for Jenkins users - Mark Waite
    • Further discussions had at Jenkins Contributor Summit - 31 Jan 2025
    • Not sure about second collaboration yet, still time for them to make decisions
  • 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.