Documentation office hours - March 20, 2025

Community
,
1

Agenda

2025-03-20

Attendees:

  • Kevin Martens
  • Bruno Verachten
  • Birajit
  • Meg McRoberts
  • Patrik Mane
  • Mark Waite

Agenda

  • Contributor spotlight
    • Next spotlight, featuring Yaroslav Afenkin, will be published by the end of this week or beginning of next week.
      • Will also be performing additional interviews over the coming weeks for further spotlights.
      • Spotlights to be published once per month
  • 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)
        • Kevin also using this setup and seems to work
        • Others have shared that they have run things successfully
      • 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
      • Kevin added links to various docker installation instructions (Docker engine & docker desktop)
    • Potentially work with Mark on initial setup/run
  • Documentation fixes implemented
  • 2025 Jenkins Community awards
    • 3 Categories:
      • Most Valuable Contributor
      • Most Valuable Advocate
      • Security MVP
    • Nomination period open now until Apr 14, 2025
    • Voting will start on April 22 and close on June 5
    • Winners will be announced at cdCon 2025 (June 23 - 25 2025)
    • Last year’s winners are not eligible for the same award this year
      • 2024 Security MVP cannot win 2025 Security MVP again, but could win Most Valuable Contributor
  • Design Library 3
    • Released in January
    • Updated UX SIG docs to include this/link to blog post
  • Google Summer of Code - Kris Stern
    • Blog announcing Jenkins in GSoC 2025
    • 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)
        • Lots of activity in GSoC gitter channel, multiple people interested
        • Potentially starting from scratch for the Gatsby part only vs working from what was done in ‘23, but definitely reusing the Antora part from the 2023 project
          • May be more consistent to start over but further discussions will be had
    • Stories site retooling/rebuild/modernize (to some degree)
      • May want to standardize how the stories site is (compared to spotlight)
        • Multiple people interested in this as well
    • Project overview meetings held (March 5 & 6)
  • 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
    • 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
  • 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.
1 Like