summaryrefslogtreecommitdiff
path: root/blog/2023/05/20/planning.mdwn
blob: 92ae1e3a20c7116f35bcbea06ae9238a7d3dd6a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
[[!meta title="Iteration planning: May 20 – June 03"]]
[[!meta date="2023-05-02 15:30:00 +0000"]]
[[!tag meeting]]

[[!toc levels=2]]

# Assessment of the iteration that has ended

Actions from the previous meeting:

- DONE: Daniel to determine what happened and ensure we won't lose our
  OSS SaaS subscription.
  - we're good for another year
- NOT DONE: Lars to produce a list of dependencies of Subplot, for
  [[!subplotissue 119]].
  - carried over to this new iteration
- DONE: Lars to change the MRSV CI pipeline to NOT run clippy or
  formatting checks.
  - [[!mr 323]]

We made progress, if not quite all we planned in the previous planning
meeting. The highlight of the past month is that Subplot now allows
any number of markdown files to be used ([[!subplotissue 318]]).

We're getting close reaching the current goal. This feels good.


We had an in-person meeting and decided to extend the iteration until
today. There were pancakes.

# Discussion

## Async meeting

Due to scheduling problems, we couldn't do a synchronous video meeting
today, so we're doing this async using a merge request.

## 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 didn't review any issues, but did review merge requests, and 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 |         82 |    OK (Ick) |
| [subplot](https://gitlab.com/subplot/subplot)                                   |          51 |           270 |        1 |        320 | OK (GitLab) |

The open MR in the subplot repository ([[!mr 331]]) didn't need
discussing in the meeting, and is under ongoing review.

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 will work on reducing Subplot dependencies that aren't already
    in Debian
  - need the dependency list; we are not targeting bookworm

## 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.

# 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 think we can finish goal 3 this iteration. We intend to work on the
following issues ([[!ms 10]]).

- [[!subplotissue 119]] -- _Subplot is in not in Debian unstable_
  - Lars to produce a list of crates in the Subplot dependency graph
    that aren't in Debian bookworm. This doesn't fully resolve the
    issue, but is a necessary step forwards.
- [[!subplotissue 268]] -- _Re-enable reference.md_
  - Also requires fixing up any problems that crop up.
  - Assigned to Lars, who is eager to finish goal 3.
- [[!subplotissue 305]] -- _Maybe create binary releases?_
  - Assigned to both Daniel and Lars. Should be done as part of, or
    just after the release for this iteration.
- [[!subplotissue 323]] -- _Make release to mark end of goal 3_
  - Assigned to Daniel.

Stretch goals for this iteration, to be completed if there's time and
energy, or dropped from the iteration if not:

- [[!subplotissue 96]] -- _Error for "do not understand binding"
  should say in what file the not-understood binding use is found_
  - To implement this, add location information to `Scenario` and
    `ScenarioStep`, and to the `BindingUnkown` error variant.
  - Assigned to Lars, who has been doing error location changes
    recently.
- [[!subplotissue 235]] -- _The Subplot subplot (`subplot.md`) is too long_
  - Lars to split up the long file into shorter ones. This doesn't
    necessarily fully resolve the issue as it doesn't update the
    contents to follow what we now think are best practices, but it's
    a step forward at least.
- [[!subplotissue 317]] -- _Lacks a way to force `docgen` to produce output_
  - Lars keeps being annoyed by this. Might just drop the "do we
    really need to write output?" feature or turn it into optional
    behavior.
- [[!subplotissue 319]] -- _https://subplot.tech/ has broken links to examples_
  - Lars runs a cron job to check links and will amend it to find the
    broken links, and then submit an MR anything found by the link checker.
- [[!subplotissue 322]] -- _Subplot should warn in code block has identifier, but no .file attribute_
  - Lars will try to do this, as it's something that recently annoyed
    him.

## Actions

No additional actions this time.


# Meeting participants

- Daniel Silverstone
- Lars Wirzenius