Documentation Office Hours - Jun 2, 2023

2023-06-02T03:00:00Z

2023-06-02 (Asia)

Attendees

  • Mark Waite
  • Meg McRoberts
  • Kris Stern
  • Ashutosh Saxena

Agenda

  • Google Summer of Code
    • Docker quickstart project - Ashutosh Saxena
      • Bruno recommended that Ashutosh attend to familiarize himself
      • Using docker compose to configure Jenkins and its agents
        • First compose file will be simplified for a first time user
        • Building the first docker file, seeing errors, and making the fixes
        • Intend to complete the compose file
          • Questions from Kris Stern
            • Should we set shm_size (needed it for gitlab plugin project)
            • Should we set restart to “on-failure” or “no”
          • Questions from Mark Waite
            • Should we use privileged: true?
            • Should we use user: root?
    • Versioned documentation for Jenkins User Handbook
      • Site will be at https://docs.jenkins.io using Antora to show versioned docs
      • Need to have a preview site configured so that we see the site in action
        • May need coaching from Gavin Mogan or Jenkins infra
      • May have something to show in the office hours next week
        • Image migration to the new structure is a manual process, will take lots of work
  • 2.401.1 changelog and upgrade guide is released
    • Mark made two mistakes in assembling changelog, two items were already delivered in earlier LTS releases
      • Mark to fix his mistakes
  • 2.401.2 release is in 4 weeks, Kris Stern is release lead
    • Docs team needs to create the changelog and upgrade guide for 2.401.2
      • Kevin returns June 12, may be able to do the changelog and upgrade guide
  • Internationalization and localization pull request from JE-Chen merged
    • New pull request has been submitted to migrate another page or two
    • Meg is willing to review
    • Looking for the structural changes - where to place the content for best use
  • Operating system End of life notifications in Jenkins core
    • Pull request merged, will be in Jenkins 2.407 and in Jenkins 2.413.1
    • blog post complete and redirect now links to blog post
  • Container end of life (coming)
    • CentOS 7 controllers (already showing the end of life warning)
    • AlmaLinux 8
    • ArchLinux agents (low volume distribution, unmaintained)
  • Should we document the tested operating systems at Jenkins release?
    • In the versioned documentation should we note the operating systems that ran automated tests
      • Packaging repository today tests installs of Fedora 37, RHEL 8, RHEL 9, Debian 10, Debian 11,
      • List the Java versions we were using at the time of release
  • May Newsletter needs submissions
    • Mark owes several submissions, get them ready soon
  • Question from Kris to Ashutosh
    • Have you planned how to document the details of the compose file?
      • Some form of “running notes” or “lab notes” or “I did this because” to remember decisions
        • Sometimes can use those “running notes” as a blog post idea source