Documentation office hours - Feb 18, 2022

Community
,
1

2022-02-18T02:00:00Z

Participants

Mark Waite (@MarkEWaite), Dheeraj Singh Jodha (@dheerajodha) , Meg McRoberts, Kristin Whetstone (@kwhetstone ), Sahitya Gupta

Notes

  • News
    • Jenkins 2.335 released with UI improvements and systemd based Linux installer
      • Bug reports are arriving from the UI improvements
      • Bug reports are expected on the Linux installer
    • Jenkins 2.332.1 is coming - March 9, 2022 LTS release
      • UI improvements “phase 1” (plugin manager, tables, etc.)
      • Need a changelog and an upgrade guide
      • First review of a draft next week (just after the delivery of RC)\
        • Looking forward to review the draft
        • UI improvements mean that more effort will be needed in the draft
        • Blogpost may be helpful, good to have a reference for elsewhere
          • Likely the same week as the release (March 9, 2022)
  • Jenkins is the Way content merge for jenkins.io - Gavin
    • Jenkins is the Way conversion
    • Mark to work with infra team to host jenkinsistheway.jenkins.io
      • GitHub repository
      • Site (could be on netlify, elsewhere)
    • Currently hosting wiki.jenkins.io as a Docker image in our Kubernetes cluster
      • Can use
      • Will we continue to accept contributions to Jenkins is the Way?
        • Yes, but likely with pull requests
      • Will we have a search facility for the site?
    • Gitter conversation between Kristin and Gavin is later in the meeting
  • Weekly changelog review process
    • Is the async technique working?
      • Concern that won’t be able to look at them multiple times in a week
      • Review once on Monday, 30 minutes review, provide feedback
        • Need to complete before Mark’s end of day Monday
          (before previous Docs office hours)
    • What should we improve?
      • Mark send reminder emails on Sunday evening or early Monday
      • Candidates to become copy editors receive the reminders
        • Waiting on the EasyCLA registration process on Jenkins infra
        • Contributor license agreement required to be a copy editor
  • LTS changelog and upgrade guide
    • 2.332.1 backpoort candidates being finalized
    • Release candidate scheduled for next week
    • Review at next office or before next office hours
    • Consider a blogpost to highlight
  • Adding a “Troubleshooting” section to User Handbook
    • Trying an operation in Jenkins fails, works from the command line
      • Selenium tests
      • Operating system user specific tests
      • PATH specific conditions
      • …
    • Zainab will submit a pull request to start that move
      • Create the new Troubleshooting section
      • Move existing page content to the new location
      • Redirect those two existing pages to the new location
        • See content/welcome.adoc for a redirect example file
          • /doc/book/troubleshooting/diagnosing-errors/ as the redirect destination
      • Noted that the log or error message should be included in the page
      • Better to have a separate chapter for visibility and breadth
      • Wiki has a page like that - can reuse the content
      • Separate section in the user guide
      • Are there other troubleshooting sections that should be collected here?
        • Could we rank higher than stackoverflow for Jenkins answers?
  • Good first issues
    • Fixing a documentation bug - Wadeck’s report of broken links
    • Try again later to find and fix the images
    • Want to merge the security section restructure first
      • Let’s ask Daniel for approval to merge, then we refine further
      • Filter disable is removed from the 2.332.1 LTS (another reason to merge)
  • Linux installers switch from System V init to systemd
    • Done in 2.335 released yesterday
      • Resolves 10+ open issues related to Linux installers
      • Automated tests now run on many Linux distributions at least weekly
    • Needs a blogpost, delayed by other work