Assessment of the iteration that has ended

The previous iteration was Subplot milestone 13.

There were no actions from the previous meeting.

Subplot development has been quiet, mostly due to work. But we’re closing goal 3 now.

Discussion

The gitlab.com hosting situation

We reviewed the billing page for Subplot on gitlab.com. It all looks OK.

We will review the billing page every iteration or two.

Repository review

We reviewed issues (see below) and MRs. We made the decision to keep the reference test MR open until the release process during the next iteration.

We also checked in on CI pipelines for all the projects in the Subplot group on gitlab.com.

Extra branches: none.

During the meeting we merged:

• web!92 – docs: meeting memo
  
• Subplot merge request 353 – tests: re-enable reference.subplot
• Subplot merge request 354 – tests: don’t run website example in –offline mode

No open MRs remained.

Recurring items issues

There are some issues tagged recurring-agenda-item in the issue tracker, which we discuss in every iteration meeting.

• subplot#119 – Subplot is in not in Debian unstable
  • Our plan is to wait until we can do cargo update using the Rust toolchain in Debian testing without having to adjust any of the dependencies to newer version, before we approach Debian about packaging Subplot.
  • We hope that an active Debian developer has interest in Subplot, as we neither in position to actively help in maintaining packages in Debian of Subplot and its dependencies. Time will tell if this happens.

What’s remaining for current goal?

Nothing. We closed it.

Goals

Goal 4: new current goal

High level description of goal 4:

• It is plausible for someone to write a new Subplot for their project without support from Lars or Daniel.
• We shall aim for someone to do the above at or around Christmas 2023
• There shall be at least some general “Acceptance testing with Subplot” documentation as well as the expected usage material.

Things we might want issues for etc.

1. Installation document
2. Getting started.
   • Introduction to acceptance criteria
   • Tutorial / my-first-subplot-document
3. Step library documentation
4. General reference material for Python and Rust runners
5. Installable binary (cargo install is too much for non-Rust people)
   • Maybe a .deb?
   • Maybe just a downloadable binary and a subplot-install.sh
6. Tolerable HTML output
   1. Correct (not broken HTML as it is right now)
   2. Table of contents
   3. Some styling support (even if not a pretty style yet)
   • Maybe this involves templating the HTML somewhat?

Order of work:

• Engineering: 5, then 6.1 (maybe incl some of 6.3), then the rest of 6
• Documentation: 2, then 1 (once 5 is done), then 3, then 4.

We adjusted issues:

• Dropped from goal 4 as not relevant to goal by our current thinking:
  • Subplot issue 224 – Logging feature in the subplot binary needs tests
  • Subplot issue 235 – The Subplot subplot (subplot.md) is too long
• Added to goal 4:
  • Subplot issue 36 – Docgen does not support styles / themes
  • Subplot issue 230 – Would be nice to typeset some captures using monospace
  • Subplot issue 244 – Typeset captured parts of steps differently based on type of captured value
  • Subplot issue 292 – Tutorial example is not tested by ./check
  • Subplot issue 295 – When scenario source has an empty line, the output should have a paragraph break
  • Subplot issue 305 – Maybe create binary releases?
  • Subplot issue 315 – Doesn’t allow (HTML) docgen output to be controlled via a (tera) template
  • Subplot issue 336 – HTML output is incorrect
    • assigned to Lars
  • Subplot issue 337 – docgen HTML lacks a table of contents

(Related issues on gitlab)

New text

Plan for new iteration

Issues

We did a review of all issues. Apart from the updates for goal 4, made the following changes:

• Subplot issue 335 – Doesn’t use DCO or Signed-off-by
  • we’ll adopt DCO
  • we need to update our contribution guide
  • assigned to Daniel
• Subplot issue 304 – Directory where subplot was invoked is not made available to tests
  • closed as not something we want to do
• web#5 – Logo looks different on different machines, depending on locally installed fonts
  • Lars will convert the image to a form where the viewer doesn’t need the font
• Subplot issue 334 – Generated Rust code causes clippy warning
  • assigned to Daniel
  • should be an easy fix

We created Subplot milestone 14 with the following issues:

• web#5 Logo looks different on different machines, depending on locally installed fonts
  • assigned to Lars
• Subplot issue 334 Generated Rust code causes clippy warning
  • assigned to Daniel
• Subplot issue 335 Doesn’t use DCO or Signed-off-by
  • assigned to Daniel
• Subplot issue 336 HTML output is incorrect
  • assigned to Lars

Actions

No additional actions.

Meeting participants

• Daniel Silverstone
• Lars Wirzenius