summaryrefslogtreecommitdiff
path: root/blog/2023/08/planning-2023-08-12.mdwn
blob: bb7b632323960f84b16000d3500f47375125eb7d (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
[[!meta title="Iteration planning: August 12–26"]]
[[!meta date="2023-08-12 13:30:00 +0100"]]
[[!tag meeting]]

[[!toc levels=2]]

[previous meeting]: /blog/2023/07/planning
[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 12]].

There were no actions from the [previous meeting][].

We have made good progress and have nearly finished goal 3. See below
for what's left.

# 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][]              |           0 |             4 |        0 |         86 |    OK (Ick) |
| [subplot][]                  |          47 |           283 |        0 |        340 | OK (GitLab) |

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_
  - 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?

We resolved all the main issues we identified last month around goal 3
but there are still two issues left with the goal 3 label.

- [[!subplotissue 305]] _Maybe create binary release?_ remains as the
  officially last thing we need to do for goal 3
- [[!subplotissue 330]] _Re-enable reference.md after next release_
  which needs to be done once the goal 3 release is completed.
- [[!subplotissue 332]] _Define and document clearly ... breaking change_
  needs to be compeleted so that we do not accidentally break things
  in the future.

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

# Plan for new iteration

## Issues

We did a very brief skim of recent issues and decided on what we needed
for this final iteration which we wanted to keep pretty lightweight,
but with a release at the end to complete goal 3 - we will make that
release in person together at our next meeting.

We created [[!ms 13]] with the following issues:

- [[!subplotissue 305]] _Maybe create binary release?_ remains as the
  officially last thing we need to do for goal 3
  - Lars and Daniel to discuss and explore this further. If we choose
    not to do this for goal 3 it will not be a problem
- [[!subplotissue 330]] _Re-enable reference.md after next release_
  which needs to be done once the goal 3 release is completed.
- [[!subplotissue 332]] _Define and document clearly ... breaking change_
  needs to be compeleted so that we do not accidentally break things
  in the future.
- [[!subplotissue 333]] _Make a release_
  In order to complete goal 3 we must make a release, so here we go.

After these are all done, we have finished goal 3.

We also labelled [[!subplotissue 303]] with fixed-in-next-version.

## Actions

No additional actions.

# Meeting participants

- Daniel Silverstone
- Lars Wirzenius