Bug 34955 - One Koha manual
Summary: One Koha manual
Status: Pushed to main
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords: rel_23_11_candidate
Depends on:
Blocks:
 
Reported: 2023-09-29 07:28 UTC by Aude Charillon
Modified: 2023-12-01 15:11 UTC (History)
7 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
From 23.11, there is one 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.
Version(s) released in:
23.11.00


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Aude Charillon 2023-09-29 07:28:52 UTC
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.
Comment 1 Aude Charillon 2023-09-29 07:37:02 UTC
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
- ...
Comment 2 Caroline Cyr La Rose 2023-10-25 12:02:44 UTC
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...
Comment 3 Caroline Cyr La Rose 2023-10-30 14:13:38 UTC
I tested some ways to add notes about the versions in bug 29712

Let me know if you have any comments or suggestions...
Comment 4 Martin Renvoize 2023-11-30 16:37:38 UTC
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.
Comment 5 Martin Renvoize 2023-11-30 16:46:31 UTC
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"
Comment 6 Jonathan Druart 2023-11-30 17:09:47 UTC
(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.
Comment 7 Tomás Cohen Arazi 2023-12-01 15:11:54 UTC
(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.