View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0005126 | GNUnet | documentation | public | 2017-08-24 08:02 | 2019-02-28 10:17 |
| Reporter | nikita | Assigned To | nikita | Due Date | |
| Priority | low | Severity | text | Reproducibility | N/A |
| Status | closed | Resolution | won't fix | ||
| Target Version | 0.11.0 | Fixed in Version | Git master | ||
| Summary | 0005126: find ways to translate documentation and enable it | ||||
| Description | Once we have resolved https://gnunet.org/bugs/view.php?id=5120 and https://gnunet.org/bugs/view.php?id=5123 we should consider a way to offer a translated documentation. As Texinfo has no native way to include translations in one source file, we have to look at sphinx-intl (http://www.sphinx-doc.org/en/stable/intl.html one way to use it is visible here: https://github.com/tork-a/openrtm_tutorial/blob/devel/README.rst) Ideally the work on this would be done via translationsproject.org | ||||
| Additional Information | What problem does this solve if it adds more work? We are aiming for a global usage, this is why we need to be able to offer documentation in more than just English. --- NOTE: We need to do A, then B, and afterwards A and B w need to do C to get to the point where we can work on D. Otherwise work on D is possible but rather pointless. Nevertheless we can point out that D needs to be done. So what I need is something like: in D: D depends on C. in C: C depends on B. in B: B depends on A. D is in this case 'THIS' ticket, and A,B,C is everything else that needs to be done on the documentation to some extent. | ||||
| Tags | No tags attached. | ||||
| I think we need to first focus on improving the *quality* of the documentation, before looking to have it translated. IMO, having the main Web site translated would be great, but the detailed TeXinfo manuals are still far from the quality that I'd feel OK with giving to translators, as right now they would likely just waste their time. | |
| I fully agree here, and if Mantis had a priority listing option with different sublevels, this would've been created with the lowest priority in 'documentation'. Precondition is fixing the documentation. I thought that much would be clear, but thanks for clearing it up for the bypassers without the whole image. | |
| From what I have read it is best to create separate documents per language and add language extensions to the filenames. I am closing this bug as we are far from a state where we could consider starting translations. edit: Apparently I can not close children which have parents. I would have expected that parent with existing children would not work, but this? urgh. | |
| Ack. As for separate documents per language, I think we'll probably want separate directories given that we have the documentation split over various files (and on top-level we could then keep shared non-translatable graphics). But: yes, far away. | |
| WONTFIX: The solution is to create individual files. We are far from having a good English documentation, so we will revisit a more accurate bug once we get to a state where the documentation is good enough to be translated. | |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2017-08-24 08:02 | nikita | New Issue | |
| 2017-08-24 08:03 | nikita | Priority | normal => low |
| 2017-08-24 08:03 | nikita | Severity | minor => text |
| 2017-09-27 08:49 | nikita | Summary | translate documentation => find ways to translate documentation and enable it |
| 2017-09-27 08:49 | nikita | Description Updated | |
| 2017-09-27 08:49 | nikita | Additional Information Updated | |
| 2017-09-27 09:36 | Christian Grothoff | Note Added: 0012444 | |
| 2017-09-27 14:06 | nikita | Note Added: 0012448 | |
| 2017-09-27 14:08 | nikita | Additional Information Updated | |
| 2017-09-27 15:48 | nikita | Additional Information Updated | |
| 2017-09-27 18:25 | nikita | Relationship added | child of 0005120 |
| 2017-09-27 18:26 | nikita | Relationship deleted | child of 0005120 |
| 2017-09-27 18:28 | nikita | Relationship added | parent of 0005141 |
| 2018-10-21 11:11 | nikita | Note Added: 0013282 | |
| 2018-10-21 11:11 | nikita | Assigned To | => nikita |
| 2018-10-21 11:11 | nikita | Status | new => assigned |
| 2018-10-21 11:13 | nikita | Note Edited: 0013282 | |
| 2018-10-21 11:34 | Christian Grothoff | Note Added: 0013284 | |
| 2018-10-21 11:35 | Christian Grothoff | Assigned To | nikita => |
| 2018-10-21 11:35 | Christian Grothoff | Reproducibility | have not tried => N/A |
| 2018-10-21 11:35 | Christian Grothoff | Status | assigned => confirmed |
| 2018-10-30 18:15 | nikita | Relationship deleted | parent of 0005141 |
| 2018-10-30 18:18 | nikita | Assigned To | => nikita |
| 2018-10-30 18:18 | nikita | Status | confirmed => resolved |
| 2018-10-30 18:18 | nikita | Resolution | open => won't fix |
| 2018-10-30 18:18 | nikita | Fixed in Version | => Git master |
| 2018-10-30 18:18 | nikita | Note Added: 0013303 | |
| 2019-02-12 08:20 | Christian Grothoff | Target Version | => 0.11.0 |
| 2019-02-28 10:17 | Christian Grothoff | Status | resolved => closed |