Bug 37539 - Improve the documentation for the OCLC Connexion Daemon / Gateway in the manual
Summary: Improve the documentation for the OCLC Connexion Daemon / Gateway in the manual
Status: RESOLVED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: Rudolf Byker
QA Contact: Testopia
URL:
Keywords:
Depends on: 37538
Blocks:
  Show dependency treegraph
 
Reported: 2024-07-31 14:57 UTC by Rudolf Byker
Modified: 2024-08-18 19:17 UTC (History)
5 users (show)

See Also:
Change sponsored?: Sponsored
Patch complexity: String patch
Documentation contact: Rudolf Byker
Documentation submission: https://gitlab.com/koha-community/koha-manual/-/merge_requests/942
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments
Improve the documentation for the OCLC daemon (768.19 KB, patch)
2024-07-31 15:06 UTC, Rudolf Byker
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Rudolf Byker 2024-07-31 14:57:48 UTC
Patch incoming. This is a follow-up for https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37538
Comment 1 Rudolf Byker 2024-07-31 15:06:00 UTC
Created attachment 169895 [details] [review]
Improve the documentation for the OCLC daemon

Patch attached. This is for the koha-manual repo.
Comment 2 David Cook 2024-08-01 00:05:09 UTC
I'm not sure of the process for manual changes, so I've asked in the Documentation channel for more info...
Comment 3 David Cook 2024-08-01 00:43:59 UTC
(In reply to David Cook from comment #2)
> I'm not sure of the process for manual changes, so I've asked in the
> Documentation channel for more info...

It looks like we don't use Bugzilla for updates to the manual: https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual#Editing_the_manual_-_using_a_local_repository_and_editor
Comment 4 Rudolf Byker 2024-08-01 03:08:56 UTC
Yay, merge requests! It's a much easier workflow, IMO. I will open the MR. How do I close or reject this bug?
Comment 5 David Nind 2024-08-01 03:31:33 UTC
(In reply to Rudolf Byker from comment #4)
> Yay, merge requests! It's a much easier workflow, IMO. I will open the MR.
> How do I close or reject this bug?

We use Bugzilla to track documentation changes, so leaving this bug is fine:
- for changes to the Koha code, the status of a bug is changed to "Needs documenting" once it is pushed to the last maintenance release it will go in (release maintainers do this)
OR
- a bug in the documentation component, we use the "Needs documenting" status (although I can't seem to change it to that for this one, so I wouldn't worry about that).

Once you have made the merge request, in Bugzilla:
1. Add your name to the "Documentation contact" Bugzilla field
2. Add a link to your merge request for the "Documentation submission" Bugzilla field
3. The documentation team manager will review - there may be comments back and forwards until they are happy.
4. Once the merge request is approved, it will be incorporated into the manual with continuous build process (can take an hour or so, depending).
5. Once it is merged, you can change the bug to "FIXED CLOSED"

For an occasional or one off change, using the GitLab interface is probably easier https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual#Editing_the_manual_-_using_the_GitLab_web_interface (unless you are more familiar with git and are happy to work on it locally).

Post in the Documentation channel in the chat if you have questions.
Comment 6 Rudolf Byker 2024-08-01 03:41:00 UTC
Done! Thanks.
Comment 7 David Nind 2024-08-01 23:45:29 UTC
I changed the status to "Needs documenting".

Because of the way the Koha workflow is set up in Bugzilla (aimed at changes to the Koha code base), I needed to change the status a few times to get the right status shown:
1. RESOLVED FIXED
2. REOPENED
3. Needs documenting

The status can be changed to RESOLVED FIXED once the merge request goes through.
Comment 8 David Nind 2024-08-18 19:17:00 UTC
The merge request was merged on ~15 August 2024.