Skip to content

Write the operator quickstart, including what an empty repository means #55

Description

@iderex

Depends on the release scope and on the address existing.

The quickstart is three steps and should stay three steps. Where the setting is,
what to paste, and what to expect.

The part worth more care is what comes after, because the failure modes of a
plugin repository are unusually quiet. A server that cannot reach the address
shows an empty list. A server that reaches it and cannot parse it shows an empty
list. A server whose version matches no entry in the catalogue shows an empty
list. Three different problems, one symptom, no error message, and an operator
with no way to tell them apart.

So the troubleshooting section is not an afterthought here, it is most of the
value. It should give the operator a way to distinguish those three from their
own machine, with the commands to do it, and it should say plainly what to check
first.

It also has to say what is normal. How long until a new plugin version appears
after it is released, so that somebody does not report a bug against a schedule
working as designed.

Done when

The quickstart is three steps, the troubleshooting section distinguishes
unreachable, unparseable and version-mismatch with a command for each, and the
expected delay between a plugin release and its appearance is stated.
Reading-decidable.

Metadata

Metadata

Assignees

Labels

blocked-on-maintainerWaiting on the maintainer, not on a piece of workdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions