Documentation office hours - Jan 13, 2022

Community
,
1

2022-01-13T18:00:00Z

Participants

Mark Waite (@MarkEWaite) , Kristin Whetstone, Zainab Daodu, Elizaneth Okaome

Notes

  • News
    • Jenkins 2.319.2 has released, security release
    • Planning is in progress for GSoC
    • Planning soon for She Code Africa Contributhon
  • Questions related to new contributors to Jenkins docs
    • Good first issues on the GitHub site are outdated or all have been claimed
      • not many available, many need review
      • Ought to place a monthly reminder to update the “good first issues” labels
    • Documentation or video to configure jenkins.io development on Windows?
      • Using Gitpod for jenkins.io development
      • Easier than configuring it on your own machine
      • As the configuration changes, the gitpod config on repo is updated
        • Avoid doing your own
    • What would a contributor do?
      • Register for gitpod.io
      • Fork the jenkins.io repository
      • Start a GitPod project from that jenkins.io repository
      • Submit pull requests
      • Mark propose a time for next week when Jean-Marc Meessen could show us how it works for him
        • Mark send a doodle poll to Elizabeth, Zainab, and Jean-Marc to find a time that we can use for later reference
    • Example of other applications of gitpod.io in tutorial
    • Considering creating a series of blog posts on Jenkins to host on www.jenkins.io
  • Review outstanding PRs
  • She Code Africa Contributhon idea review
    • Inclusive naming initiative in the Jenkins project
      • Confirm mentors for core and for the targeted plugins
    • Pipeline help improvements
      • Confirm mentors and plugin maintainers for the targeted plugins
    • Test automation - converting automated tests
      • Git plugin uses JUnit 3 tests, they need to be converted to JUnit 4
      • Other plugins have a similar need for JUnit 3 to JUnit 4 conversion
      • May not be as interesting because most students start in Javascript
        • Could consider one or two that are interested in Java
      • Project ideas form allows us to guide to choose people with specific skills
        • Assure that we can answer the project idea questions in proposal
    • Fix multiple tutorials
      • Getting Started
        • include links to more details on each of the steps
    • Test multiple tutorials and report problems detected
      • Good for a first time user, but a testing project, not a programming project
    • Other projects outside development are allowed as well
      • Community management
        • Like in the Advocacy and Outreach SIG
      • Web design improvements for www.jenkins.io
      • Developer page navigation for Extend Jenkins
        • Make it navigate like the user page
        • Docker
      • Artwork from designers, but would need a month’s worth of work
    • Screenshot updates for www.jenkins.io
      • March 2.33x.1 will include significant UI updates
    • Gitpod development environment in each of these cases
      • Very good idea - many of them do not have a fast local computer
      • Need to do some advance testing with volunteers in Africa
  • New Year blog post review

Site previews on www.jenkins.io pull requests

2

Can’t you just use the period key on github?

3

Didn’t know about that. It looks very interesting. Visual Studio Code in a web browser for editing. Unfortunately, I don’t see a way to have it render the site (equivalent of make run). I’d need to submit a pull request and wait for the site generator to render the changes.

The Gitpod technique renders the site while I’m in development mode.

The GitHub integrated editor may be enough for edits that don’t require rendering of the site.

4

Yea as I do everything locally i hadn’t looked into it much either

looks like they do the full gitpod style setup via GitHub Codespaces · GitHub
Looks like they support a “devcontainer” “standard” here Introduction to dev containers - GitHub Docs
I know devcontainers can be used in local vscode (I’ve seen but not used it in homeassistant).

It’s def something to look into more. I love tooling that describes your environment so you can use whatever editor you want (like https://editorconfig.org/)

Not to derail this project, but something I’ll look into when my todo list is smaller.

5

example dev container - room-assistant/.devcontainer at main · mKeRix/room-assistant · GitHub
its on the gitpod roadmap - Support `devcontainer.json` · Issue #16 · gitpod-io/roadmap · GitHub