Documentation team meeting 2023-10-19

maximilian · October 16, 2023, 8:47am

This is just the agenda for the meeting at 14:00 - 14:30 (CEST). Join via https://meet.google.com/zih-cgjz-czo

General

Follow up on last week’s issues

new issue based on thread in Foreman Community Forum: Update Keycloak Authentication docs · Issue #2499 · theforeman/foreman-documentation · GitHub

Triage

Anything updated within the past week can be ignored during triage. If someone wants to discuss a specific issue/PR then it should be added to the agenda.

Review open PRs
Review open issues

maximilian · October 17, 2023, 8:31am

Let’s also discuss Installation guides state Puppet 5 is the minimum version · Issue #2333 · theforeman/foreman-documentation · GitHub

ekohl · October 17, 2023, 3:24pm

I’d propose we discuss adding required checks to the repository. See About protected branches - GitHub Docs for more about this. The short summary is that we can say that a check like build-html must pass, otherwise the PR can’t be merged.

maximilian · October 17, 2023, 4:05pm

I have pushed to 3.4 and broke GHA:

It’s fixed now.

ekohl · October 19, 2023, 4:34pm

General

When creating the agenda for the meeting, remember to make it a wiki so others can add agenda items to it instead of adding comments. To do this, you create a post as normal and click the wrench icon. In the menu that pops up there’s "Make Wiki. See Create a Wiki Post - moderators - Discourse Meta for a screenshot.
To create calendar event, go to Events - TheForeman and use New Topic as in other places. On the events subforum the New Topic dialog has a button “New Event” to add a time.
Update Keycloak Authentication docs · Issue #2499 · theforeman/foreman-documentation · GitHub @ekohl will follow up and find someone who knows Keycloak.
Installation guides state Puppet 5 is the minimum version · Issue #2333 · theforeman/foreman-documentation · GitHub updated in the issue.

Branch protection

We’ve applied branch protection on master. It now requires the build-html and build-web status checks to pass, otherwise you can’t merge. While we generally trust reviewers to not merge when it’s broken, this also prevents merging when GitHub Actions for some reason doesn’t run at all. This also prevents (accidental) force pushes to master.

It was not applied on stable branches because it would break our cherry pick workflow.

Triage

Went over a few PRs and provided more context to some issues