https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |ASSIGNED --- Comment #1 from David Nind <david@davidnind.com> --- Here is a rough outline of what I am thinking about. Tasks: - Fine tune the revised contents/structure - Make available in a shared document for comments/interactive feedback - Reorganise the index page for feedback (make available as a static site) Potentially each of the sections could be separate guides, rather than one big manual, with the contents page organising and linking these together. Initial focus would be on reorganising the contents, and then later reorganising content in individual sections/chapters/guides where required - including adding new sections. Revised contents outline, with notes ==================================== Using this manual/documentation [about the documentation and how it is organised] - Conventions - Change log [quick notes on what has changed in the documentation, for example a new guide on a new feature added] What's new in Koha [more user-friendly 'release' notes] Koha overview [brief introduction to Koha - key features, modules and tools; the community] Getting help Part X - Getting started [brief outline of process to consider when implementing, with links to more detailed information/guides/tutorials] - Implementation [including links to the checklists] - Data migration - Installation - System setup and configuration - System administration [including managing upgrades] Part X - Using Koha [sections/chapters/guides on each of the modules, tools and other features - not sure of the best way to group or organise this yet] - Finding your way around [getting familiar with the OPAC and staff interface] - Searching [may be an advanced search guide as well?] - Patron guide to using the OPAC - The core modules: . Circulation . Patrons . Cataloging . Authorities [combine with cataloguing?] . Serials . Acquisitions . Reports .... - Other modules, features, and tools [not sure how to group yet] . Course reserves . ERM . Interlibrary loans . Lists . News . Notices and slips . Patrons . Point of sale .... - Enhanced content, integration, and web services [separate sections or part of above topics where appropriate] - Customising the OPAC and staff interface . Look and feel [theming] . JavaScript and CSS Part X - Implementation guide Part X - Data migration guide [getting your data into Koha] Part X - Installation guide Part X - System setup and configuration - Using languages other than English Part X - System administration - Backups - Security - Scheduled jobs [cron jobs] - Search engines - Upgrades Part X - System preferences [Reference] Part X - Cron jobs [Reference] Part X - Package commands [Reference] Index Glossary License information -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- URL| |https://docs.google.com/doc | |ument/d/1KyrsMVWG_kcVvbFsUk | |ysRC9oovIbFCNTNgCwSyM4SL0/e | |dit?usp=sharing -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 --- Comment #3 from David Nind <david@davidnind.com> --- Created attachment 144530 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=144530&action=edit Documentation landing page - WIP This is a screenshot, just to show some current progress. Working through each existing section and adding it under the relevant heading. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 Jonathan Druart <jonathan.druart+koha@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart+koha@gmail. | |com -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 --- Comment #5 from David Nind <david@davidnind.com> --- I didn't really get any feedback at the time I posted to the development list. Since it was a while ago, and there are more Documentation team members, I'll add to the agenda for the next documentation meeting (https://wiki.koha-community.org/wiki/Documentation_meeting_27_September_2023) -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 --- Comment #7 from David Nind <david@davidnind.com> --- (In reply to Martin Renvoize from comment #6)

The one caveat I see here is that we'd need to carefully test the contextual linking from inside Koha to the manual.. But I like the look of the screenshot so far :)

Thanks Martin! Most of the initial changes are on the main index page, so shouldn't affect the content pages at the moment. But definitely will keep in mind if any of the content pages are changed, and new pages added. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 --- Comment #8 from Aude Charillon <aude.charillon@ptfs-europe.com> --- Sorry, just realised I forgot to comment on the bug itself! (doh) The feedback from the 27/09 Documentation team meeting was: "It looks good, please go ahead"! And also: thank you for looking into this. We'll probably want to re-organise the sub-sections in more depth at some point, but that will be something for later... -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 Heather <heather_hernandez@nps.gov> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |heather_hernandez@nps.gov --- Comment #10 from Heather <heather_hernandez@nps.gov> --- Hi! I'm looking at: Using Third Party Software With Koha > OCLC Connexion Gateway I would like to rename that: OCLC Connexion Because only bibs can be transferred to Koha via the Gateway interface, and the section also includes instructions for using batch export from Connexion and Stage MARC Records import in Koha. Also, right now, there are two interfaces on the Connexion side: Connexion Browser (Until 30 April 2024) and Connexion Client (now and in the future). Resources like the Wiki refer to the Browser, e.g.: https://wiki.koha-community.org/wiki/OCLC_Connexion And I think the manual could be clearer if this section were just, "OCLC Connexion," and then this section within it: Setting up your OCLC desktop client Were changed to: Setting up your OCLC Connexion Client OCLC Connexion Browser is no longer supported by OCLC as of 30 April 2024. OCLC Connexion Client is desktop software available from OCLC to subscribers. After it is downloaded and installed, to set up the OCLC Connexion Client for use with Koha, go to... I think this would make it clearer to those unfamiliar with OCLC that it is a paid, subscription service and the Client is the required desktop software, which must be used to get the MARC records from OCLC. So I think this is an example of a section that is ideal to be a "separate guide" and I'd like to work on the content now that the software interface is changing for a lot of libraries (from the Browser to the Client). I think it's in a good place, under "Using Third Party Software With Koha." Cheerio! h2 -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 --- Comment #12 from Heather <heather_hernandez@nps.gov> --- That would be great, Aude!! I'll get my thoughts and notes together and be in touch--it would be so helpful to look at it with you--I am such a newbie with the manual and would appreciate your guidance! Thank you!!! -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 Emmanuel Bétemps <e.betemps@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |e.betemps@gmail.com -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 --- Comment #13 from Aude Charillon <aude.charillon@ptfs-europe.com> --- To note: as agreed at the February 2024 Documentation meeting, the What's new page has been added to the Manual side navigation. (Merge request 842 https://gitlab.com/koha-community/koha-manual/-/merge_requests/842) -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 --- Comment #15 from David Nind <david@davidnind.com> --- Here is the link to updated preview https://davidnind.gitlab.io/koha-docs-reorganise/index.html Still a few things to complete before doing a merge request: - Add some content to under development sections - Cards for the "Using Koha" section - Add an index and sitemap -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |23756 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23756 [Bug 23756] [DOCS] [Omnibus] How-to and tutorial sections for the manual (including library workflows and use cases) -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32391 --- Comment #17 from David Nind <david@davidnind.com> --- Finally, some movement! The updated home page for the manual is now live at https://koha-community.org/manual/latest/en/html/index.html Still some things to do, and feedback is welcome either here or in the Mattermost documentation channel. -- You are receiving this mail because: You are watching all bug changes.