Documentation office hours - January 23, 2025

Agenda:

2025-01-23

Attendees:

  • Kris Stern
  • Mark Waite
  • Bruno Verachten
  • Meg McRoberts
  • Soham Juneja

Agenda

  • Contributor Spotlight
    • Currently featuring James Nord
      • First spotlight of 2025 will be with Kohsuke Kawaguchi
        • Provided lots of great stories, insights, and content
        • Kevin still working through interview/transcripts to put together a complete story
      • Change up the publication cadence with historical spotlights
  • Jenkins Contributor Summit - 31 Jan 2025 in Brussels, Belgium
    • Bruno Verachten has shared the work in progress agenda
      • Draft agenda
        • Morning reports
          • Proposed to reduce from 3 hours to 2 hours
          • Allow more time for discussions and breakout sessions
        • Afternoon breakout sessions for specific topics
          • Maintenance
          • Infra
          • Security
          • UX SIG
          • Jenkins 3
      • Outcomes
        • Face to face discussions of important topics
        • Results from last year
          • Plugin health score
          • UX improvements (Pipeline graph view)
      • Won’t be streamed, but summaries will be shared
        • Each breakout leader will summarize the breakout results in a 5 minute presentation
    • Updates from SIG leaders and officers
    • Breakout sessions for group work on Jenkins
  • Blog posts
    • Google Summer of Code call for mentors
    • 2024 year in review
      • Thanks to Roxanne from CDF for sponsor image & header images
      • Thanks to Mark and Governance board for helping ensure all the sponsors were included
      • Thanks to everyone for their contributions and input on the content of this post
    • Announcement of Jenkins Design Library 3
      • Thanks to Jan Faracik for putting this together and everyone who worked on this to bring it to life
    • Jenkins & Alpha-Omega December Update
      • Initial CSP project completed
      • Thanks to Shlomo Dahan and Yaroslav Afenkin for all of their work on this
      • Thanks to Bruno Verachten and Basil Crow for their leadership and guidance
      • Looking forward to hopefully working with Alpha-Omega again in the near future
  • LTS 2.479.3 released successfully
  • LTS 2.492.1 to be released on February 5 2025
    • Release candidate is available now, testers are welcomed
    • PR for Changelog & upgrade guide
      • Included a Windows test update in the “Changes since 2.492” section to circumvent a rendering issue that was found in Kevin’s local testing (needs further investigation/testing)
        • Kevin to potentially create an issue if the problem seems more involved/deeper
  • Weekly 2.493 and 2.494 released without any issues
    • 2.495 looks to be on track as expected
  • Alpha Omega documentation project idea - improving open source security for Jenkins users - Mark Waite
    • Further discussions at Jenkins Contributor Summit - 31 Jan 2025
    • Create multiple tutorials or documentation pages that show how to use specific security tools with Jenkins
      • Generating an SBOM with Jenkins - Darin Pope video as a starting point
        • Java SBOM
        • JavaScript SBOM
        • Python SBOM
        • Golang SBOM
      • Signing files with sigstore
      • SLSA compliant builds with Jenkins
      • creating a new Maintainer tutorial
  • 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
  • Chinese documentation site and Chinese localization plugin
    • Planned to retire it, but there are 58000 installations of the Chinese localization plugin
      • Removing Chinese docs site does not block Chinese Jenkins users, but …
    • Add a banner that the Chinese material is out of date
      • Alternately add a banner that invites users to answer a survey or to contribute
      • Alternatively add a banner that warns the site will be removed and invites a vote to keep it
      • Alternative - add google analytics and watch the results
    • Should we consider a Jenkins project funded translation to Chinese?
  • Blue Ocean Deprecation
    • Work to remove Blue Ocean from documentation has begun
      • Blue Ocean plugin development docs removed to avoid encouraging users from doing so
      • Blue Ocean tutorials moved to bottom of page along with adding a status note
      • First attempt to remove Blue Ocean from Docker installation guide - instruction needs to be replaced with Docker compose instructions before Blue Ocean can be removed as there are far more references to Blue Ocean than the PR suggests.
        • Needs discussion around what has to be done to incorporate docker compose into the installation guide.
        • Barriers to replacing the Docker installation guide with Docker Compose instructions
        • Changing the Docker installation guide to be more Production focused than more tutorial/smaller scale installation, this would require more doc rework than what my initial suggestion would involve
          • Refer to tutorials for what that might look like
        • May need to revisit Kubernetes install guide as well
        • Bigger than just Blue Ocean deprecation
      • What to do with small references within documentation
        • Copy and paste into a separate page for historical retention?
        • Update the instructions to just remove these pieces if they are no longer relevant?
      • For Blue Ocean section of documentation, not everything will have a 1:1 replacement, so what to do with pages that are not redirected
        • Create some sort of archived docs folder in the repo that doesn’t get included in the site
        • Add a “deprecated” tag/text to the main page header to indicate that these functionalities are deprecated
        • What to replace some things with (Pipeline Graph View plugin, Branch API plugin, etc)
        • Pages like Dashboard & Activity View appear to be Blue Ocean specific, so these would not necessarily make sense to keep around or even redirect (unless there is a suitable replacement for them via another plugin)
          • The plugins replacing these functionalities do not necessarily have extensive documentation (like the current Blue Ocean docs) so what would be the best course of action to incorporate those pieces of information
        • Plan further for documentation updates/removal in the UI more than full deletion/removal