Documentation office hours - January 9, 2025

Community
,
1

2025-01-09

Attendees:

  • Kevin Martens
  • 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
      • Change up the publication cadence with historical spotlights
  • Jenkins Contributor Summit - 31 Jan 2025 in Brussels, Belgium
  • Blog posts
    • Google Summer of Code call for mentors
      • Still waiting for Google to announce GSoC (bit behind/later than usual)
        • Don’t want to start and then have to stop suddenly
        • Unsure of when/if this might happen
      • Build retooling of jenkins.io
        • Goal to have versioned docs site
        • Continuation of project from GSoC 2023
    • Upcoming blog post: 2024 recap
      • Thanks to Roxanne from CDF for sponsor image & header images
        • Sponsor image needs approval from Governance Board before this can be merged (determine whether sponsors are categorized properly)
      • If there is anything that should be highlighted but is missing, please share that feedback so that it can be added to the blog
    • Upcoming blog 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
      • Already reviewed/approved, will be published tomorrow
  • Jenkins elections
    • Election results
      • The results are in, and we welcome Valentin Delaye & Alex Earl to the board.
      • We also welcome back Alexander Brandes as a returning member of the governance board.
      • The officers will remain in and continue their roles for another term, thanks to all of them for their work and commitment to the project.
      • Thanks to all the participants who submitted nominations, registered, and voted.
  • LTS 2.479.3 released successfully
  • Next LTS to be released on February 6 2025
    • Current baseline discussion is in favor of 2.492
      • 2.492 contains backports and fixes that would have been necessary to incorporate after the fact if 2.491 was used.
    • Kevin to start compiling changelog & upgrade guide over the next week
  • Weekly 2.490, 2,491, and 2.492 released
    • 2.491 done off schedule to revert a regression/update introduced in 2.490
  • Alpha Omega documentation project idea - improving open source security for Jenkins users - Mark Waite
    • Create multiple tutorials or documentation pages that show how to use specific security tools with Jenkins
      • Generating an SBOM with Jenkins
        • 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
  • Recent work done on jenkins.io
  • 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
1 Like