Documentation office hours - Dec 12, 2024

Community
,
1

2024-12-12 (EU/US)

Attendees:

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

Agenda

  • Contributor Spotlight
    • Currently featuring James Nord
      • Discussed in previous Advocacy & Outreach meeting that the spotlight will join rest of Jenkins project in 2 week break at end of year, so this will be the last spotlight for 2024
      • Discussed in Advocacy & Outreach about potential “other” type of posts for the contributor spotlight
        • Top Advice
        • Jenkins first impressions vs now
        • Jenkins historical contributors (have shared list of potential candidates with Alyssa for connecting and scheduling)
  • Blog posts
    • Alpha-Omega progress report 2
      • Thanks to Bruno Verachten for writing this up.
      • Thanks to Basil Crow for guiding the work on this project
      • Thanks to Shlomo Dahan and Yaroslav Afenkin for all of their continued efforts in improving CSP in Jenkins.
      • Lots of amazing work continuing the progress, working from the top down (in regards to installations), biggest plugins and components have already been addressed
      • This work is also helping plugin maintainers understand what work needs to be done in the future to keep up with CSP
    • Pull request titles show directly in Jenkins
      • Thanks to Jan Faracik for doing the work in the Branch API plugin to make this possible.
      • Comes from a user request in this Jenkins JIRA ticket
      • Another case of migrating functions from Blue Ocean to other locations (Pipeline Graph View, etc)
  • Jenkins elections
    • Election results
      • Voting has concluded and counted
      • The results are in, and we welcome Valentin Delaye & Alex Earl to the board.
      • We also want to 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.2 released successfully
  • 2.479.3 to be released on January 8 2025
  • Weekly 2.488 & 2.489 released
    • Work done by Alex Earl, that was reverted, is coming back with the issue resolved
      • Windows users, ran into issues with “upgrade now” button
      • Windows registry is not updated with the current Jenkins version
      • What needs to be done to match the controller
    • 2.490 will be last weekly release of 2024
    • Weekly & LTS releases will be paused for 2 week end of year break
  • Jenkins security advisory for Nov 27, 2024
    • Includes Jenkins core and Plugins
  • 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
      • 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 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
  • Recent work done on jenkins.io
  • Stats.jenkins.io dark mode is available now!
  • Jenkins Contributor Summit - 31 Jan 2025 in Brussels, Belgium
    • Mark Waite has proposed prioritized list of Contributor Summit attendees to have travel funded by Software in the Public Interest
  • 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