From 39b47252ad1fa6c935957e44120c66aa02d01172 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sun, 8 May 2022 09:08:18 +0300 Subject: add minutes from yesterday's meeting Sponsored-by: author --- blog/2022/05/07/planning.mdwn | 164 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 164 insertions(+) create mode 100644 blog/2022/05/07/planning.mdwn (limited to 'blog') diff --git a/blog/2022/05/07/planning.mdwn b/blog/2022/05/07/planning.mdwn new file mode 100644 index 0000000..f52cb59 --- /dev/null +++ b/blog/2022/05/07/planning.mdwn @@ -0,0 +1,164 @@ +[[!meta title="Iteration planning: May 7 – 21"]] +[[!meta date="Sat, 7 May 2022 15:30:00 +0300"]] +[[!tag meeting]] + +[[!toc levels=2]] + + +# Assessment of the iteration that has ended + +[previous iteration]: /blog/2022/04/23/planning + +We had planned to work on the following issues for the [previous +iteration][], and finished them: + +- [[!issue 255]] -- _Should use "diagram" instead of "graph" for plantuml etc?_ +- [[!issue 256]] -- _Lacks way to mark an embedded file as being OK that it's not used in a scenario_ + +We didn't finish this issue: + +- [[!issue 283]] -- _YAML metadata is not in its own file_ + - Lars has made a little effort at preparing to work on this by + tidying up some error handling, but ran into a desire to rewrite + all of Subplot from scratch. + +# Repository review + +We reviewed the open issues, merge requests, and CI pipelines for all +the projects in the Subplot group on gitlab.com. + +## The `subplot` repository + +There were 45 open issues and we opted to review only recently changed +ones. + +- [[!subplotissue 283]] -- _YAML metadata is not in its own file_ + - Daniel convinced Lars to not rewrite Subplot from scratch and + instead only do a small change to parse a YAML file using the + `serde_yaml` crate, and then construct a `Document` from that. + Further improvements to follow as a series of small changes. + - `ast.rs` has its own `Metadata` type that is already almost + suitable for this. + - More substantial changes should await for Daniel to make his + marked Markdown/YAML parsing usable. +- [[!subplotissue 284]] -- _Switch to using clap3 and the derive + feature, rather than the outdated structopt crate_ + - Daniel wanted to do this, and updated the description. + +There are no open merge requests. + +There is one open, old branch: + + - `docgen-cmark` -- _prototype to use another Markdown parser_ + - Lars wants keep this until the current goal is finished + +CI pipelines are OK. + +## The `subplot-web` repository + +There were no open issues, no open merge requests, no extra branches, +and no CI enabled. + +## The `subplot-container-images` repository + +There was one open issue. + +- [subplot-container-images#2](https://gitlab.com/subplot/subplot-container-images/-/issues/2) + -- _There is no Docker image for using Subplot_ + - we're not going to work on this until we stop making breaking + changes + +Additionally, Daniel pointed out that our Docker image has an extra +version of Rust included. He created [[!containerissue 3]] to get this +fixed. + +There were no open merge requests, no extra branches, and the latest +run of CI was successful. (That's the run that was automatically +triggered recently.) + +# Discussion and decisions + +## Group level milestones + +We decided to use GitLab's group level milestones. + +## [Recurring agenda items](https://gitlab.com/subplot/subplot/-/issues?sort=updated_desc&state=opened&label_name[]=recurring-agenda-item) + +- [[!subplotissue 119]] -- _Subplot is in not in Debian unstable_ + - we're not going to work on this until we are done with goal 3 +- [[!subplotissue 272]] -- _Migrate project to issue-based iteration meetings_ + - we're not going to work on this until we have other contributors +- [[!subplotissue 273]] -- _Perform whole-codebase review and cleanup_ + - we agreed that during goal 3 we may end up making MRs which are + related to this, and that we hope by the end of goal 3 to have + reviewed at least a large part of the code base. + +## Reaching out for feedback + +We won't be reaching out for feedback until goal 3 is done. We didn't +open issue for this, to avoid naming people in public. + +# New iteration + +## Current goal + +The current development goal is: + +> 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. + +This is represented as label +[`goal::3`](https://gitlab.com/subplot/subplot/-/issues?sort=created_asc&state=opened&label_name[]=goal::3) +in the GitLab.com issue tracker. + +## Issues for this iteration + +We collected issues for this iteration in [[!ms 1]]. + +- [[!containerissue 3]] -- _Remove 1.48 from the container_ + - assigned to Daniel +- [[!subplotissue 283]] -- _YAML metadata is not in its own file_ + - assigned to Lars +- [[!subplotissue 284]] -- _Switch to using clap3 and the derive + feature, rather than the outdated structopt crate_ + - assigned to Daniel + + +## Releases + +We decided not to make a release for this iteration. We will make a +release after the YAML metadata loading change is done, maybe next +iteration. + +# Any other business + +Nope. + +## Gitlab approved open source project + +There has been no response from GitLab, Daniel will ping them. + +Lars mused about setting up his own CI runner for Subplot. However, we +don't have the resources to support anything but Debian, and so this +probably won't happen. + +# Actions + +* Daniel to ping GitLab.com about making Subplot an approved open + source project. +* Daniel to review his marked Markdown/YAML approach and make a plan + for getting into a state where Subplot can use it. +* Lars to add an Ikiwiki shortcut for referring to the new group level + milestones. +* Lars to reach out to Hillel Wayne about having a look at Subplot. + +# Meeting participants + +- Daniel Silverstone +- Lars Wirzenius -- cgit v1.2.1