Documentation Office Hours - Jun 15, 2023

Community
,
1

2023-06-15T16:00:00Z

2023-06-15 (EU/US)

Attendees

  • Mark Waite
  • Bruno Verachten
  • Kevin Martens

Agenda

  • Google Summer of Code
    • Docker quickstart project - Ashutosh Saxena
      • May need some more pushing, should be at a point for a draft PR
      • No draft pull request yet
    • Building jenkins.io with alternate tools
      • Styling changes / improvements described in a Google doc
      • Preparing a GitHub pages layout from Antora for discussion and review
        • Preview site
        • Happy to have a review by the UX SIG and Docs SIG
      • Destination is https://docs.jenkins.io for versioned documentation
        • Gavin Mogan did the first implementation of preview sites for jenkins.io
        • Infra team did changes as requested by Gavin
      • Great look with some minor questions
        • Is there a way for accessibility to increase contrast (light blue background on code examples may make them more difficult to read)?
          • Current site has higher in Mark’s view than in the screenshot
        • Love the sticky navigation on the left, will the table of contents on the right “stick” as well?
          • Should it? Does it stick on other Antora sites?
      • Hoping that a preview will be ready as GitHub pages soon
  • Errors in 2.401.1 changelog
    • Discovered by Darin Pope during 2.401.1 live stream
    • At least two items that need to deleted from the 2.401.1 changelog (already in earlier LTS releases)
    • Removal PR submitted
  • 2.401.2 changelog & upgrade guide created
  • New pull request from JE-Chen needs review
    • Meg McRoberts is willing to review, look for preferred destinations for the content
    • Kevin is back and will review as well
      • Structural changes, where to put things
      • Regularly merging from master branch into the working branch
      • Specific tasks include:
        • Replace the rename instructions with UI screenshots and instructions
        • Remove the “Batch renaming” section
        • Remove the “backup and restore”, already have a better page
        • Move the “Archiving a job” into the “backup and restore”
        • Move the “JENKINS_HOME” into “Configuring the system” under “Manage Jenkins”
          • Consider adding some text to describe XML configuration files
          • Accept that the inline descriptions of each item in the listing are OK
            • May change it in the future, but OK for now
    • Bruno reviewed and commented on the text content
  • End of life notifications in Jenkins core
    • Done and running since 2.407, a fix included in 2.409 for Fedora 38 users
    • Backported so that this is included in 2.401.2
    • Arrives in next LTS baseline (approximately 10 weeks from now - Aug 23, 2023)
  • Container controller end of life (needs pull request to Jenkins core)
    • CentOS 7 controllers (already showing the end of life warning)
    • AlmaLinux 8 controllers
  • Container agents end of life (needs even more work before it is possible)
    • ArchLinux agents (low volume distribution, unmaintained)
    • Versions node monitor plugin (already provides something like this, a report on outdated versions of Jenkins remoting and JDK)
    • Platform labeler provides automatic labels of agents based on process on the agent
      • Reads a file from agent file system
    • Platform SIG has a spreadsheet with additional information on these agents.
  • 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
    • Created a ticket to track the idea
  • May Newsletter needs submissions
  • Bruno has a blog post that needs to be reviewed as well
  • Bruno has a draft PR regarding the use of updatecli to keep examples up to date in the jenkins.io documentation