meeting: Notes from 3rd June meeting

Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>

1 files changed, 182 insertions, 0 deletions

diff --git a/blog/2023/06/03/planning.mdwn b/blog/2023/06/03/planning.mdwn
new file mode 100644
index 0000000..0362472
--- /dev/null
+++ b/blog/2023/06/03/planning.mdwn
@@ -0,0 +1,182 @@
+[[!meta title="Iteration planning: June 3 – June 17"]]
+[[!meta date="2023-06-03 13:30:00 +0100"]]
+[[!tag meeting]]
+
+[[!toc levels=2]]
+
+# Assessment of the iteration that has ended
+
+The previous iteration was [[!ms 10]]
+
+Actions from the previous meeting:
+
+- DONE: Lars to produce a list of dependencies of Subplot, for
+  [[!subplotissue 119]].
+  - There are six direct-dependency crates entirely missing
+  - Many insufficent versions which are not listed in the issue for now
+
+We have made several small changes during this iteration, though we did
+not complete the planned release. Fortunately things came up in this
+iteration which means it was a good thing as we'd otherwise have to
+do another release now.
+
+We're getting even closer to reaching the current goal. This feels good.
+
+# 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 | Closed MRs |          CI |
+| :------------------------------------------------------------------------------ | ----------: | ------------: | -------: | ---------: | ----------: |
+| [subplot-container-images](https://gitlab.com/subplot/subplot-container-images) |           1 |             4 |        0 |          3 | OK (GitLab) |
+| [subplot-web](https://gitlab.com/subplot/subplot-web)                           |           1 |             3 |        0 |         84 |    OK (Ick) |
+| [subplot](https://gitlab.com/subplot/subplot)                                   |          50 |           273 |        1 |        334 | OK (GitLab) |
+
+The open MR in the subplot repository ([[!mr 333]]) is related to `reference.md`
+
+Extra branches: none.
+
+## 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_
+  - we have updated the issue with the current not-yet-packaged
+    list of direct dependencies. No more action expected at this time.
+
+## What's remaining for current goal?
+
+We can re-enable `reference.md`, and then make a release. When we do,
+we should see if we can use GitLab CI to build an executable binary of
+the release.
+
+There is an optional task to split `subplot.md` into multiple files
+([[!subplotissue 235]]), which may involve rewriting some of it using
+what we've learned about writing good subplots. However, that is a
+large task, and may need to be postponed, or splitting it into smaller
+tasks.
+
+Lars raised an issue regarding running `subplot docgen foo/bar.subplot`
+not finding markdown documents properly. [[!subplotissue 324]] needs
+resolving before we make the release for this goal.
+
+# Goals
+
+## Goal 3: Current goal
+
+Subplot is altered to treat a YAML document as the root of any subplot
+document, permitting multiple markdown files to be joined into a
+single scenario set or output document. We remove our dependency on
+Pandoc’s AST for internal document representation, and support a
+better range of document metadata as a result. We will use marked data
+types where possible to permit better provenance information in error
+and warning messages; and we will strive to reenable the reference
+tests such that we can make a statement to the effect that post goal
+3, we do not intend to make further breaking changes to the input
+formats or primary behaviours of Subplot.
+
+([Related issues on gitlab](https://gitlab.com/subplot/subplot/-/issues?label_name%5B%5D=goal%3A%3A3))
+
+## Goal 4: Planned
+
+This goal is very likely to change. It will need to be discussed in
+depth when we finish the previous goal.
+
+We'll improve documentation and generally aim at making Subplot more
+plausibly usable by people outside of the Subplot project.
+
+([Related issues on gitlab](https://gitlab.com/subplot/subplot/-/issues?label_name%5B%5D=goal%3A%3A4))
+
+# Plan for new iteration
+
+## Issues
+
+We did an issue review for all non-someday-maybe issues with a view to
+setting up the goal label for final action this iteration.
+
+- [[!subplotissue 96]] _Error for "no not understand binding"..._
+  - We removed this from iteration planning because we're not sure
+    when we can get to it - it's not important enough for goal 3.
+- [[!containerissue 2]] _There is no Docker image for using Subplot_
+  - We decided to close this as a preferable approach will be a single
+    binary release method.
+- [[!subplotissue 235]] _The Subplot subplot `subplot.md` is too long_
+  - We agreed to remove this from the iteration planning, and move it
+    from goal 3 to goal 4.
+  - This is likely to be a more complex thing than just splitting up
+    the document and we want more time to think.
+- [[!subplotissue 263]] _What is a good way to include Rust step…_
+  - We put this tentatively into goal 4.
+- [[!subplotissue 268]] _Reenable reference.md_
+  - We agreed this should be in this iteration and Lars will continue
+    to be responsible for it.
+- [[!subplotissue 287]] _Needs documentation for Rust step functions…_
+  - We put this tentatively into goal 4.
+- [[!webissue 4]] _Review FAQ_
+  - We removed this from its iteration and unassigned Daniel
+- [[!subplotissue 292]] _Tutorial example is not tested by ./check_
+  - We added goal 4 label
+- [[!subplotissue 308]] _Allow continuing commands across linebreaks_
+  - We had already selected mail style (indentation)
+  - We discussed and didn't want to add support for this in goal 3
+  - Since mail style could be a breaking change though, Lars prepared
+    [[!subplotissue 325]] which is in the goal and iteration to
+    ban indented scenario steps, this way mail style won't be a breaking
+    change when we introduce it in a later goal.
+- [[!subplotissue 319]] _subplot.tech has broken links to examples_
+  - Updated to this iteration, left assigned to Lars
+- [[!subplotissue 320]] _Doesn't verify bindings files very well_
+  - We agreed that even though fixing this would result in not accepting
+    broken bindings we previously didn't error on, this is not a breaking
+    change since those bindings wouldn't have worked anyway.
+  - We put this into goal 4
+- [[!subplotissue 321]] _Lacks a library reference manual_
+  - We put this into goal 4
+- [[!subplotissue 322]] _Subplot should warn if code block…_
+  - We agreed this is important, and that Daniel will have a go in this
+    iteration
+- [[!subplotissue 323]] _Make release to mark end of goal 3_
+  - Brought this into this iteration
+- [[!subplotissue 324]] _Can't process subplot documents that are…_
+  - Lars has self-assigned and put this into this iteration
+  - We agreed it was an mtime detection problem in docgen.
+  - We root-caused that to the markdown_filenames from the subplot
+    metadata and decided on a fix.
+  - Lars will make a MR with the fix and a scenario to ensure this
+    doesn't recur.
+
+We think we can finish goal 3 this iteration. We intend to work on the
+following issues ([[!ms 11]]).
+
+- [[!subplotissue 325]] _Scenario steps may not be indented_
+- [[!subplotissue 324]] _Can't process subplot documents that are in…_
+- [[!subplotissue 323]] _Make release to mark end of goal 3_
+- [[!subplotissue 322]] _Subplot should warn if code block…_
+- [[!subplotissue 319]] _subplot.tech has broken links…_
+- [[!subplotissue 268]] _Re-enable reference.md_
+
+## Actions
+
+No additional actions this time.
+
+# Meeting participants
+
+- Daniel Silverstone
+- Lars Wirzenius