Documentation office hours - Feb 25, 2022

Community
,
1

2022-02-26T02:00:00Z

Participants

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

Notes

  • News
    • Jenkins 2.336 released with several fixes for image and icon issues
      • Thanks to Docs office hours for changelog review
    • Jenkins 2.332.1 release candidate available for testing
  • Interactive tests that Jenkins performs prior to a weekly release?
    • At Dheeraj’s employer, there are interactive tests that are described
      • Step-wise test cases to confirm things are functional
    • Does Jenkins have those types of descriptions of test cases?
      • No, we don’t have those types of descriptions
        • Refer to James Bach, Michael Bolton, Cem Kaner
        • Association for Software Testing (AST) has courses
          • Foundations of Software Testing
          • Bug Advocacy
          • Test Design
      • What should / could we do differently to detect issues sooner?
        • 2.335 had several bugs in visual elements
        • Could we open every web page and check for broken images?
          • Find a broken image detector for authenticated web pages
        • Could consider more layers of tests (do some things only weekly)
        • In many cases, we need specific plugins in order to see the issue
          • Need to have “interesting configurations” that are easy to start and stop
            • Gavin Mogan has his interesting configuration
            • Mark Waite has his interesting configuration
      • We have regular “explorers” who use the UI and report issues
      • We have regular pull request reviewers who check pull requests are ok
    • Interactive tests that are performed by people before weekly releases
  • Linux installers switch from System V init to systemd
    • Needs a documentation page, “Managing systemd services”
      • Where does it belong?
        • In the System Administration
      • What topics should be covered?
        • Reloading service definitions
        • Registering services
        • Viewing service configurations
        • Overriding service configurations
        • Starting services
        • Stopping services
        • Reading service logs
        • Pruning service logs
      • What reference documentation could we consider?
    • See Jenkins developer mailing list proposal
    • Should we have a “Managing Jenkins on Linux”?
      • Mark tends away from this one because of how broad it is
  • Google Summer of Code
    • Pipeline steps documentation generator project idea
      • Exploring the current code base
      • Wanted to run it inside the debugger to see what was happening
        • Can it be run in a debugger?
          • Had an error in his Eclipse debugger
        • Mark uses Apache Netbeans, thinks that he ran it in the debugger
        • Kristin uses Visual Studio Code, not in debugger
          • Used the logger facility
  • She Code Africa Contributhon
    • Mark to submit project ideas before end of February
      • Project manager mentored by Mark Waite
      • Inclusive naming initiative changes for popular plugins
      • Screenshot updates for www.jenkins.io
      • Test the tutorials, report issues, improve the tutorials
      • Consider “Troubleshooting” as a section worked by a team
    • Need mentors available during Africa daylight hours
  • 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
  • 2.332.1 changelog and upgrade guide