summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2023-10-07 16:14:01 +0300
committerDaniel Silverstone <dsilvers+gitlab@digital-scurf.org>2023-10-12 14:13:00 +0000
commitf073f30aa536a7c1aa2cb3cce2a525a1f2a55f4a (patch)
tree986f469986207184761bd26bc29b47d08e7a79a4
parenta1cd9b9cca4af6a5154ec062917c383e694de96c (diff)
downloadsubplot.liw.fi-f073f30aa536a7c1aa2cb3cce2a525a1f2a55f4a.tar.gz
meeting minutes
Sponsored-by: author
-rw-r--r--blog/2023/10/07/planning.mdwn219
1 files changed, 219 insertions, 0 deletions
diff --git a/blog/2023/10/07/planning.mdwn b/blog/2023/10/07/planning.mdwn
new file mode 100644
index 0000000..12ef876
--- /dev/null
+++ b/blog/2023/10/07/planning.mdwn
@@ -0,0 +1,219 @@
+[[!meta title="Iteration planning: October 8&ndash;21"]]
+[[!meta date="2023-10-07 13:30:00 +0200"]]
+[[!tag meeting]]
+
+[[!toc levels=2]]
+
+[previous meeting]: /blog/2023/08/planning-2023-08-12
+[subplot-container-images]: https://gitlab.com/subplot/subplot-container-images
+[subplot-web]: https://gitlab.com/subplot/subplot-web
+[subplot]: https://gitlab.com/subplot/subplot
+
+# Assessment of the iteration that has ended
+
+The previous iteration was [[!ms 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](https://gitlab.com/groups/subplot/-/billings) 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](https://gitlab.com/subplot) on gitlab.com.
+
+| Repository | Open issues | Closed issues | Open MRs | Merged MRs | CI |
+| :--------------------------- | ----------: | ------------: | -------: | ---------: | ----------: |
+| [subplot-container-images][] | 0 | 5 | 0 | 3 | OK (GitLab) |
+| [subplot-web][] | 1 | 4 | 1 | 90 | OK (Ick) |
+| [subplot][] | 50 | 286 | 2 | 342 | OK (GitLab) |
+
+Extra branches: none.
+
+During the meeting we merged:
+
+- [[!webmr 92]] -- _docs: meeting memo_
+- [[!mr 353]] -- _tests: re-enable reference.subplot_
+- [[!mr 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`](https://gitlab.com/groups/subplot/-/issues/?sort=created_asc&state=opened&label_name%5B%5D=recurring-agenda-item&first_page_size=20)
+in the issue tracker, which we discuss in every iteration meeting.
+
+- [[!subplotissue 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:
+ - [[!issue 224]] -- _Logging feature in the `subplot` binary needs tests_
+ - [[!issue 235]] -- _The Subplot subplot (`subplot.md`) is too long_
+* Added to goal 4:
+ - [[!issue 36]] -- _Docgen does not support styles / themes_
+ - [[!issue 230]] -- _Would be nice to typeset some captures using monospace_
+ - [[!issue 244]] -- _Typeset captured parts of steps differently based on type of captured value_
+ - [[!issue 292]] -- _Tutorial example is not tested by ./check_
+ - [[!issue 295]] -- _When scenario source has an empty line, the output should have a paragraph break_
+ - [[!issue 305]] -- _Maybe create binary releases?_
+ - [[!issue 315]] -- _Doesn't allow (HTML) docgen output to be controlled via a (tera) template_
+ - [[!issue 336]] -- _HTML output is incorrect_
+ - assigned to Lars
+ - [[!issue 337]] -- _docgen HTML lacks a table of contents_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+This goal is very likely to change. It will need to be discussed in
+depth when we finish the previous goal.
+
+We'll improve the quality of life of people using Subplot:
+
+- we'll improve the ease of use and comprehension of the output of
+ documents generated by Subplot
+- we'll improve the documentation of Subplot itself
+- we'll make error messages and other diagnostics more helpful for
+ users to fix whatever the problem is
+
+We aim to have a fairly short and time-boxed goal 4, maybe on the
+order of two or three months. The goal 3 duration (well over a year)
+was long enough to be de-motivating to use as developers. Thus, we
+scope our actual tasks so that they are likely to be achieved by us,
+given our time and energy constraints. We'd rather have more frequent
+small goals than more ambitious goals that take a long time to
+achieve.
+
+([Related issues on gitlab](https://gitlab.com/subplot/subplot/-/issues?label_name%5B%5D=goal%3A%3A4))
+
+
+# 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:
+
+- [[!issue 335]] -- _Doesn't use DCO or Signed-off-by_
+ - we'll adopt DCO
+ - we need to update our contribution guide
+ - assigned to Daniel
+- [[!issue 304]] -- _Directory where subplot was invoked is not made
+ available to tests_
+ - closed as not something we want to do
+- [[!webissue 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
+- [[!issue 334]] -- _Generated Rust code causes clippy warning_
+ - assigned to Daniel
+ - should be an easy fix
+
+We created [[!ms 14]] with the following issues:
+
+- [[!webissue 5]] _Logo looks different on different machines, depending on locally installed fonts_
+ - assigned to Lars
+- [[!issue 334]] _Generated Rust code causes clippy warning_
+ - assigned to Daniel
+- [[!issue 335]] _Doesn't use DCO or Signed-off-by_
+ - assigned to Daniel
+- [[!issue 336]] _HTML output is incorrect_
+ - assigned to Lars
+
+## Actions
+
+No additional actions.
+
+# Meeting participants
+
+- Daniel Silverstone
+- Lars Wirzenius