[tahoe-lafs-trac-stream] [Tahoe-LAFS] #4113: Automate the NEW tutorial commands
Tahoe-LAFS
trac at tahoe-lafs.org
Thu Oct 10 15:57:42 UTC 2024
#4113: Automate the NEW tutorial commands
-------------------------------+--------------------------------------
Reporter: blaisep | Owner: blaisep
Type: task | Status: new
Priority: normal | Milestone: User Documentation Goals
Component: documentation | Version: n/a
Resolution: | Keywords:
Launchpad Bug: |
-------------------------------+--------------------------------------
Description changed by blaisep:
Old description:
> New tutorial commands are currently elaborate editing of servers.yaml or
> copy/paste.
>
> Also reduce repetition with a script (eg. justfile or pypyr pipeline)
>
> eg.
> source .venv/bin/activate
> cd docs/examples/storage0
> tahoe run .
> source .venv/bin/activate
> cd docs/examples/client0
> tahoe run
New description:
New tutorial commands are currently elaborate editing of servers.yaml or
copy/paste.
Background: The new tutorials SHALL include a automated script to run the
commands described in the instructions. So a reader can manually follow
the steps to learn to use a feature AND a CI can run tests to validate the
code examples.
Definition of done: <what is the test that would show this completed?>
--
--
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/4113#comment:2>
Tahoe-LAFS <https://Tahoe-LAFS.org>
secure decentralized storage
More information about the tahoe-lafs-trac-stream
mailing list