[Koha-bugs] [Bug 19817] New: Merge local and online documentations

[bugzilla-daemon at bugs.koha-community.org]

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19817

            Bug ID: 19817
           Summary: Merge local and online documentations
 Change sponsored?: ---
           Product: Koha
           Version: unspecified
          Hardware: All
                OS: All
            Status: ASSIGNED
          Severity: new feature
          Priority: P5 - low
         Component: Documentation
          Assignee: jonathan.druart at bugs.koha-community.org
          Reporter: jonathan.druart at bugs.koha-community.org
        QA Contact: testopia at bugs.koha-community.org

We are currently maintaining a local (help/* files) and online
(https://koha-community.org/manual) documentations.
They must be merged to ease the maintainability and improve the relevance.
The online manual has been improved greatly the last months and the obvious
solution would be to point to it from the different Koha installations.

Here is the different steps I have in mind:
- Remove existing local documentation
- Point to the relevant pages of the online documentation
- Make the online documentation configurable to add the ability to point to a
local copy (for offline access)
- Re-add the ability to edit the manual

It would make sense to have a koha-manual package depending on sphinx and copy
the related .rst files (depending on the Koha version). Then a script will be
provided (koha-build-manual) to regenerate the manual (after an update for
instance) in different languages.

For the local edition we could imagine to add add local commits when a change
is made. Advanced users/administrators will then need to rebase and eventually
fix the conflicts.

-- 
You are receiving this mail because:
You are watching all bug changes.