Documentation Office Hours - Aug 11, 2023

Community
,
1

2023-08-11T03:00:00Z

2023-08-11 (Asia)

Attendees

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

Agenda

  • Google Summer of Code
    • Docker compose for tutorials - Ashutosh Saxena
      • Steps to update the documentation to use docker compose
        • Today
          • GitHub repository for jenkins.io that includes the tutorials with all their details
          • Docker containers provided for each weekly and LTS release (controller)
          • Docker containers provided for ssh agents
          • Complicated set of instructions
        • Future
          • GitHub repository for jenkins.io that includes the tutorials with all their details
          • Docker containers provided for each weekly and LTS release (controller)
          • Docker containers provided for ssh agents
          • Docker containers for use by Docker compose (user does build the container)
            • Using Ashutosh’s personal Dockerhub account to store container now
            • Need to enlist help from the infra team to create
              • Repository for the container definitions (currently ash-sxn)
              • Dockerhub location for the container images (current Ashutosh personal)
            • Ashutosh open an infra help desk ticket
          • Pull request to jenkins.io to use the new container for the tutorials and the install guide
            • Mark prefers small pull requests, one per tutorial, one for the install guide
            • One of the tutorials depends on Blue Ocean but not Blue Ocean is not actively developed
              • Rather not sacrifice the tutorial due to Blue Ocean inactivity
              • Mark thinks tutorial should include Blue Ocean (Meg agrees, Kris also)
          • Ashutosh plans to include Blue Ocean
    • Versioned documentation for jenkins.io - Vandit Singh
      • Vandit will demo the status at UX SIG Aug 16, 2023
      • May be willing to demo to Docs Office Hours Europe
        • Next week Aug 17, 2023 (EU time)
      • More discussion today on how to fix the Antora site, then tomorrow will discuss the blog feature
    • GitLab plugin modernization - Harsh Pratap Singh
      • Mark’s testing has some questions
      • Code is working for Milestone 2
  • LTS 2.414.1
  • Adding existing requirements/support policy documentation to System Administration section (new chapter/sections)
    • Currently, support policy docs are linked in the installation guides and are searchable, but not necessarily in a section in the navigation.
    • Similarly for the Java requirements & Java upgrade docs
    • Support policy could function like “Reverse proxy configurations” with collapsable navigation
    • Meg suggested “Platform Information” as a name for the section, Kris agrees that’s a good name for the section
    • After installing, it is less likely that users would return to the installation docs
  • How to describe the process of choosing a plugin bill of materials version
    • Described in issue 2359
    • Consider using updatecli to update the version string explicitly
    • Consider including static references to older versions in addition to the most recent release
    • Consider adding a blog post that highlights how to do it
      • Might use that as seed material for Hacktoberfest
  • Java 11, Java 17, and Java 21 discussion (see Google Doc from Mark Waite)
    • Discussion, next steps, etc.
  • DevOps World Tour web site
    • Sep 13-14 - New York - Mark is speaking
    • Sep 27 - Chicago - Mark is speaking
    • Oct 18-19 - Santa Clara - Mark is speaking
    • Oct 26 - Singapore Olivier Lamy is speaking
    • Nov 29 - London Tim Jacomb is speaking
  • Mark Waite out of office Aug 14, 2023 through Aug 18, 2023
    • Meetings removed from the Jenkins calendar
    • Canceled Asia docs office hours meeting Aug 18, 2023