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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
[[!meta title="Iteration planning: October 8–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
|
