Summary: | [DOCS] [Omnibus] How-to and tutorial sections for the manual (including library workflows and use cases) | ||
---|---|---|---|
Product: | Koha | Reporter: | Christopher Brannon <cbrannon> |
Component: | Documentation | Assignee: | David Nind <david> |
Status: | ASSIGNED --- | QA Contact: | Testopia <testopia> |
Severity: | enhancement | ||
Priority: | P5 - low | CC: | aude.charillon, caroline.cyr-la-rose, david |
Version: | Main | ||
Hardware: | All | ||
OS: | All | ||
GIT URL: | Change sponsored?: | --- | |
Patch complexity: | --- | Documentation contact: | |
Documentation submission: | Text to go in the release notes: | ||
Version(s) released in: | Circulation function: | ||
Bug Depends on: | 29712, 32391 | ||
Bug Blocks: |
Description
Christopher Brannon
2019-10-04 22:56:40 UTC
Hi Christopher, I like the idea. Maybe something for the docs meeting as well? Linked to the omnibus bug regarding a content and style guide for the Manual (hopefully I've done that correctly!) Workflows have been mentioned by other members of the Documentation team and we want to try and accommodate those. We will be discussing in upcoming meetings how to do that. Everyone can take part in the discussions; see https://wiki.koha-community.org/wiki/Category:Documentation_IRC_Meetings for the next meeting dates. I've repurposed this bug for adding "How-tos" and "Tutorial" sections to the manual, which I think fits with what is described here. Once we have brainstormed some ideas on potential topics for how-tos/tutorials/use cases/library workflows at a documentation meeting (it has been on the agenda for some time), I'll create separate bugs for each topic. But feel free to add any ideas you have as a comment on this bug as well! Hopefully, we can then get "someone" to write the content! We intend to use these Good Docs Project guidelines and templates: * How-to: Guidelines - https://www.thegooddocsproject.dev/template/how-to) + Markdown template - https://gitlab.com/tgdp/templates/-/blob/main/how-to/template_how-to.md * Tutorial: Guidelines - https://www.thegooddocsproject.dev/template/tutorial) + Markdown template - https://gitlab.com/tgdp/templates/-/blob/main/tutorial/template_tutorial.md Some topics suggested so far: 1. SIP: SIP2SortBinMapping 2. Closing a library 3. Koha installation checklist (see the koha-US checklist) |