Documentation team meeting 2024-07-11

Development documentation
1

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

If you want to discuss a specific issue/PR/topic, please add it to the agenda below.

General

Follow up on last week’s issues

Triage

Anything updated within the past week can be ignored during triage.

Discussion

You can reach us on matrix.

2

The meeting will start 13:30, i.e. half an hour earlier.

3

To add to agenda: Proposal to add a Vale check as a GitHub action for PRs. The Vale at Red Hat project is public.

4

To add to agenda: Discuss implementing tabs as proposed in Implement repository configuration with asciidoctor-tabs by ekohl · Pull Request #3104 · theforeman/foreman-documentation · GitHub. Let’s talk about the proposal and the next steps.

5

Summary

  • Vale: Yes, we want vale for PRs on GitHub
  • Tabs: Yes, let’s try it out for certain upstream-only (sub)-procedures such as installation on EL8/EL9
6

Expanding on that: Vale is a linter and because it’s automated that reduces the burden on reviewers. The vale project has documentation on onboarding:

We didn’t discuss who would take the lead on it. @apinnick is that something you’ll take on?

7

Yes, I am willing to lead this.

8

I’ve updated Implement repository configuration with asciidoctor-tabs by ekohl · Pull Request #3104 · theforeman/foreman-documentation · GitHub to reflect this.