[Bug 34955] New: One Koha manual (to rule them all)
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Bug ID: 34955 Summary: One Koha manual (to rule them all) Change sponsored?: --- Product: Koha Version: unspecified Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: aude.charillon@ptfs-europe.com QA Contact: testopia@bugs.koha-community.org The Documentation team, at our meeting on 27 September 2023, voted to move from one manual per Koha version to one manual for all versions. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 --- Comment #1 from Aude Charillon <aude.charillon@ptfs-europe.com> --- One for all, and all for one! as the Musketeers would say. Which is probably a more positive literary reference than the Lord of the Rings one in the bug title?! :-D Full background to why we considered this change can be found in my message to the Koha mailing list: https://lists.katipo.co.nz/pipermail/koha/2023-September/059999.html The Documentation team considered replies and other feedback received and decided the benefits outweighed the drawbacks. We now need help to make it happen! The Documentation team will: - Deal with the Manual formatting (we will add version indications - a bit like the Weblate documentation does https://docs.weblate.org/en/weblate-5.0.2/api.html#categories) - ... We would be grateful for help with: - All the more technical points! - Changing contextual links in future Koha versions - ... -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Aude Charillon <aude.charillon@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart+koha@gmail. | |com, | |martin.renvoize@ptfs-europe | |.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Donna <bwsdonna@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |bwsdonna@gmail.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |emily.lamancusa@montgomeryc | |ountymd.gov -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Heather <heather_hernandez@nps.gov> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |heather_hernandez@nps.gov -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |caroline.cyr-la-rose@inlibr | |o.com --- Comment #2 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- Keeping the old branches on gitlab for now. Starting 23.11, we will add mentions of what is new in this version and what has been removed. The format of the notes is to be decided in the style guide... -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 --- Comment #3 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- I tested some ways to add notes about the versions in bug 29712 Let me know if you have any comments or suggestions... -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Aude Charillon <aude.charillon@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Text to go in the| |From 23.11, there is one release notes| |Koha manual for all Koha | |versions. Notes are used in | |the manual to indicate in | |which Koha version a | |feature has appeared or | |changed. Previous manual | |versions (23.05 and older) | |are not affected. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 --- Comment #4 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Jonathans set symlinks at the manual hosting end to ensure that koha help links continue to work going forward. Links will still take the form /version_number/language/page.html.. but the actual content will all just be the same as /latest. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Aude Charillon <aude.charillon@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|One Koha manual (to rule |One Koha manual |them all) | -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Text to go in the|From 23.11, there is one |From 23.11, there is one release notes|Koha manual for all Koha |Koha manual for all Koha |versions. Notes are used in |versions. |the manual to indicate in | |which Koha version a |Notes are used |feature has appeared or |in the manual to indicate |changed. Previous manual |in which Koha version a |versions (23.05 and older) |feature has appeared or |are not affected. |changed. | | | |Previous manual | |versions (23.05 and older) | |are not affected. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 --- Comment #5 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Suggest we push an empty commit for this one to ensure it appears in the release notes :) git commit --allow-empty -s -m "Bug 34955: One Koha Manual" -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |rel_23_11_candidate -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 --- Comment #6 from Jonathan Druart <jonathan.druart+koha@gmail.com> --- (In reply to Martin Renvoize from comment #4)
Jonathans set symlinks at the manual hosting end to ensure that koha help links continue to work going forward.
For the sake of completeness: symlinks have been created starting from 23.11. Older versions are preserved. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34955 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)| |23.11.00 released in| | Status|Passed QA |Pushed to master CC| |tomascohen@gmail.com --- Comment #7 from Tomás Cohen Arazi <tomascohen@gmail.com> --- (In reply to Martin Renvoize from comment #5)
Suggest we push an empty commit for this one to ensure it appears in the release notes :)
git commit --allow-empty -s -m "Bug 34955: One Koha Manual"
Did this. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org