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
|
[[!meta title="Iteration planning: October 23–November 05"]]
[[!meta date="2022-10-22 18:30:00 +0300"]]
[[!tag meeting]]
[[!toc levels=2]]
# Actions from last time
* **PARTIALLY DONE:** Lars to look at what it would take to use the
`pulldown_cmark` parser for Markdown, instead of Pandoc, and make a
concrete proposal of how to approach that.
- proposal is not written down, but in summary: we'll use the
Markdown parsing from Lars's ikiwiki clone, which gives us an AST
modeled after HTML, and this will let us not use Pandoc for
parsing at all
- later on, we may choose to generate HTML ourselves, and drop
direct support for generating PDF, and thus be able to drop
the need for Pandoc at all; however, this is speculative
* **NOT DONE:** Lars to discuss Subplot dependencies that aren't
packaged in Debian, and propose concrete steps to reduce the delta.
- we discussed this, and gave up on the goal of trying to get
Subplot into the next Debian release, to avoid putting too much
stress on ourselves
* **NOT DONE:** Daniel to open an issue with Cargo to discuss binary-only
dependencies.
- not done, due to work travel
# Assessment of the iteration that has ended
We extended, by mutual agreement on Matrix, this iteration was
extended by several weeks. Life and work intruded. Again.
We had chosen the following issues for this iteration:
- **DONE:** [[!subplotissue 246]] -- _Split off document YAML metadata
to a separate file_
- **NOT DONE:** [[!subplotissue 287]] -- _Needs documentation for Rust step
functions for implementing contexts_
- we want a book, hence #291, some discussion about book tooling
- this issue will be postponed until when we work on the book
- **DONE:** [[!subplotissue 288]] -- _Should an on-disk filename be
captured as a PathBuf?_
- **DONE:** [[!subplotissue 298]] -- _Needs a release with the
external YAML metadata file support_
- **DONE:** [[!subplotissue 299]] -- _Rust lib/files "file contains"
should print file contents_
- **DONE:** [[!subplotissue 306]] -- _We should not need a template
for docgen operations_
- **NOT DONE:** [[!webissue 4]] -- _Review FAQ_
# 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're over the limit on seats, but it
seems we can increase the seats for free.
We will review the billing page every iteration or two.
## Repository review
We reviewed issues updated since the previous
meeting, merge requests, and CI pipelines for all the projects in the
[Subplot group](https://gitlab.com/subplot) on gitlab.com.
### [Subplot Container Images](https://gitlab.com/subplot/subplot-container-images)
- Open issues: 3
- Merge requests: 0
- Additional branches: 0
- CI: OK, ran on Friday
### [subplot-web](https://gitlab.com/subplot/subplot-web)
- Open issues: 1
- Merge requests: 1 (this meeting)
- Additional branches: 1 (this meeting)
- CI: Ick, OK.
### [subplot](https://gitlab.com/subplot/subplot)
- Open issues: 50
- Merge requests: 0
- Additional branches:
- `docgen-cmark`, Lars is keeping this around for reference for
future changes
- CI: OK
## 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 dependence list; we are not targeting bookworm
- [[!subplotissue 272]] -- _Migrate project to issue-based iteration
meetings_
- we are effectively doing MR based meetings
- close this issue
- [[!subplotissue 273]] -- _Perform whole-codebase review and cleanup_
- we don't feel like doing this
- we will instead do more frequent refactors
# 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. This is merely an initial sketch.
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 intend to work on the following issues
([[!ms 6]]):
- [[!containerissue 4]] -- _Container is based on debian:buster - use bullseye instead?_
- [[!containerissue 5]] -- _Dockerfile could maybe be simplified_
- [[!webissue 4]] -- _Review FAQ_
- [[!subplotissue 239]] -- _In metadata, `author` is a single string_
- [[!subplotissue 281]] -- _Parsing markdown with Pandoc doesn't handle basedir_
## Actions
These are in addition to work on issues chosen for this iteration.
- Lars to add to decisions document to lower threshold for making
refactoring to improve code quality
# Meeting participants
- Daniel Silverstone
- Lars Wirzenius
|
