Skip to content

Write the documentation an operator reads before installing the first release #95

Description

@iderex

The README today describes an intention. At the first release it has to describe
a thing that exists, and it has to be honest about how small that thing is,
because the alternative is somebody installing it expecting a client.

What this produces

A first paragraph saying what this is and what it is not, in the register the
organisation's own state table already uses.

What an operator needs to run the probe, what it will tell them, and what to do
with the output.

The data page from #74 linked and summarised, since somebody deciding whether to
point this at their own server is deciding what happens to their data.

The licence from #12 named.

The known limitations, listed rather than implied, including every published
speed number this release does not yet measure.

Done when

README.md describes the released thing rather than the intention, every claim
in it is either checkable by a command it names or marked as a claim, and a
person who has never seen the repository can install and run the probe from it
alone. Blocked on #12, #74, #91, #92.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

blocked-on-dependencyWaits on another issue; line: owner/repo#N or repo#N, prefer the native blocked_by; waiting-kinds.mddocumentationImprovements or additions to documentationreleaseVersioning, artifacts, and what an operator installs

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions