View Issue Details

IDProjectCategoryView StatusLast Update
0006696Talerdocumentationpublic2022-01-12 02:25
ReporterFlorian Dold Assigned Tottn  
PrioritynormalSeveritytextReproducibilityhave not tried
Status assignedResolutionopen 
Summary0006696: discuss better structure for LibEuFin docs
DescriptionThe LibEuFin docs are currently pretty chaotic. We should come up with a better structure.

I guess there are three different target audiences for the docs:
* Operators of LibEuFin (who want to use it with Taler)
* Developers who want to use the LibEuFin API
* Core Developers of LibEuFin ("internal stuff, documented in public")
TagsNo tags attached.

Relationships

related to 0007147 assignedttn libeufin-{sandbox,nexus,cli} needs a manpage 

Activities

ttn

2021-01-29 19:42

developer   ~0017449

Well, the HOWTO (tutorial) is clearly targeted at the Operator audience. I don't know what the distinction is between the other two audience groups are, however.

ttn

2021-02-02 21:34

developer   ~0017490

Applicable not just to Libeufin, but all Taler documentation:
https://documentation.divio.com/

ttn

2021-08-11 04:55

developer   ~0018093

Please see recent commits in docs.git/libeufin/*.rst --
the "target audience" can be "operator", "developer", "core developer".
(Feel free to add/correct my guesses.)

ttn

2022-01-12 02:25

developer   ~0018632

Just managed to "manually" build/install libeufin. When i tried to run libeufin-cli, i saw an error:

 ModuleNotFoundError: No module named 'click'

This makes sense since i don't have that module installed on my system (yet).
Anyway, we should probably document these runtime dependencies, and additionally
make sure the Debian packaging declares them so that they are installed automatically.

Issue History

Date Modified Username Field Change
2021-01-13 23:50 Florian Dold New Issue
2021-01-13 23:50 Florian Dold Status new => assigned
2021-01-13 23:50 Florian Dold Assigned To => ttn
2021-01-29 19:42 ttn Note Added: 0017449
2021-01-30 23:55 Christian Grothoff Severity minor => text
2021-02-02 21:34 ttn Note Added: 0017490
2021-06-02 09:58 Christian Grothoff Assigned To ttn => Christian Grothoff
2021-07-13 06:48 Christian Grothoff Assigned To Christian Grothoff => ttn
2021-08-11 04:55 ttn Note Added: 0018093
2022-01-11 11:06 ttn Relationship added related to 0007147
2022-01-12 02:25 ttn Note Added: 0018632