View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0006696 | Taler | documentation | public | 2021-01-13 22:50 | 2026-09-19 14:44 |
| Reporter | Florian Dold | Assigned To | Antoine A | Resolution deadline | |
| Implementer | Reviewer | ||||
| Release signed by | Deployed by | ||||
| Verifier | Communicator | ||||
| Data protection authority notification required | No | ||||
| CSIRT notification required | No | ||||
| Estimated effort (hours) | Actual effort (hours) | 0 | |||
| Fast-track | No | ||||
| Work package | none | ||||
| Priority | normal | Severity | text | Reproducibility | have not tried |
| Status | informing | Resolution | fixed | ||
| Target Version | 1.6 | Fixed in Version | 1.6 | ||
| Summary | 0006696: discuss better structure for LibEuFin docs | ||||
| Description | The 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") | ||||
| Tags | discussion-needed | ||||
| 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. | |
| Applicable not just to Libeufin, but all Taler documentation: https://documentation.divio.com/ | |
| 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.) | |
| 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. | |
| The documentation at https://docs.taler.net/libeufin/bank-manual.html#id5 mentions: > Refer to the manpage libeufin-man.conf(5) for the full array of configuration values. But the manual page does not seem to be available as a Debian package (I installed `libeufin-bank` from `apt`). | |
| LibEuFin documentation is now split into bank, Nexus, ebisync, dialect, and EBICS-setup manuals and explicitly labels operator/developer target audiences. The old Python Click dependency comment is obsolete after the implementation rewrite, and source manpages now cover the referenced configuration. | |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2021-01-13 22:50 | Florian Dold | New Issue | |
| 2021-01-13 22:50 | Florian Dold | Status | new => assigned |
| 2021-01-13 22:50 | Florian Dold | Assigned To | => ttn |
| 2021-01-29 18:42 | Note Added: 0017449 | ||
| 2021-01-30 22:55 | Christian Grothoff | Severity | minor => text |
| 2021-02-02 20:34 | Note Added: 0017490 | ||
| 2021-06-02 07:58 | Christian Grothoff | Assigned To | ttn => Christian Grothoff |
| 2021-07-13 04:48 | Christian Grothoff | Assigned To | Christian Grothoff => ttn |
| 2021-08-11 02:55 | Note Added: 0018093 | ||
| 2022-01-11 10:06 | Relationship added | related to 0007147 | |
| 2022-01-12 01:25 | Note Added: 0018632 | ||
| 2022-08-25 19:11 | Christian Grothoff | Project | Taler => libeufin |
| 2023-01-08 10:29 | Christian Grothoff | Target Version | => 0.11 |
| 2023-04-13 18:29 | Florian Dold | Project | libeufin => Taler |
| 2023-04-13 19:59 | Christian Grothoff | Assigned To | ttn => MS |
| 2023-09-03 16:18 | Christian Grothoff | Assigned To | MS => Antoine A |
| 2023-12-22 13:35 | Christian Grothoff | Target Version | 0.11 => post-1.0 |
| 2025-04-23 22:55 | Christian Grothoff | Assigned To | Antoine A => |
| 2025-04-23 22:55 | Christian Grothoff | Status | assigned => implementing |
| 2025-05-19 07:28 | how | Note Added: 0024927 | |
| 2025-05-20 09:55 | schanzen | Relationship added | related to 0009973 |
| 2026-02-07 21:46 | Christian Grothoff | Tag Attached: discussion-needed | |
| 2026-08-04 23:23 | Christian Grothoff | Assigned To | => Antoine A |
| 2026-08-04 23:23 | Christian Grothoff | Status | implementing => assigned |
| 2026-08-04 23:23 | Christian Grothoff | Status | assigned => implementing |
| 2026-08-27 07:00 | Florian Dold | Status | implementing => informing |
| 2026-08-27 07:00 | Florian Dold | Resolution | open => fixed |
| 2026-08-27 07:00 | Florian Dold | Note Added: 0029606 | |
| 2026-09-19 14:40 | Christian Grothoff | Fixed in Version | => 1.6 |
| 2026-09-19 14:44 | Christian Grothoff | Target Version | post-1.0 => 1.6 |