Updating Koha manual documenation
Hey all, What's the procedure for updating Koha manual documentation? I'd like to expand on http://manual.koha-community.org/3.20/en/sru.html#sru_search. I see there is a kohadocs.git to which Nicole contributes (http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary), but do those changes still go through Bugzilla? Does one clone the repository and just post the patches to Bugzilla and mark it as documentation? And then Nicole/RM does the merging from there? I basically just want to add that searching "title" will use "index.dc.title" because the default set in pqf.properties is "dc", and that you can use other sets by adding the prefix like "f bath.keyTitle=test" in yaz-client when using "querytype cql". But there's heaps of other search documentation that I'd like to edit, so I figure I may as well get up to speed on the procedure! I've been saying for years that I should contribute to the documentation, so maybe I should put my words where my... words are! David Cook Systems Librarian Prosentient Systems 72/330 Wattle St Ultimo, NSW 2007 Office: 02 9212 0899 Direct: 02 8005 0595
I think it should follow the regular BZ workflow. 2016-04-20 4:00 GMT-03:00 David Cook <dcook@prosentient.com.au>:
Hey all,
What’s the procedure for updating Koha manual documentation?
I’d like to expand on http://manual.koha-community.org/3.20/en/sru.html#sru_search. I see there is a kohadocs.git to which Nicole contributes ( http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary), but do those changes still go through Bugzilla?
Does one clone the repository and just post the patches to Bugzilla and mark it as documentation? And then Nicole/RM does the merging from there?
I basically just want to add that searching “title” will use “index.dc.title” because the default set in pqf.properties is “dc”, and that you can use other sets by adding the prefix like “f bath.keyTitle=test” in yaz-client when using “querytype cql”.
But there’s heaps of other search documentation that I’d like to edit, so I figure I may as well get up to speed on the procedure! I’ve been saying for years that I should contribute to the documentation, so maybe I should put my words where my... words are!
David Cook
Systems Librarian
Prosentient Systems
72/330 Wattle St
Ultimo, NSW 2007
Office: 02 9212 0899
Direct: 02 8005 0595
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
-- Tomás Cohen Arazi Theke Solutions (http://theke.io) ✆ +54 9351 3513384 GPG: B2F3C15F
Agreed. There is a 'Documentation' category in bugzilla. The documentation is in docbook format; I'm sure that you could supply patches, or I'm sure that Nicole would be happy to make edits if you supply the text. --Barton On Wed, Apr 20, 2016 at 8:59 AM, Tomas Cohen Arazi <tomascohen@gmail.com> wrote:
I think it should follow the regular BZ workflow.
2016-04-20 4:00 GMT-03:00 David Cook <dcook@prosentient.com.au>:
Hey all,
What’s the procedure for updating Koha manual documentation?
I’d like to expand on http://manual.koha-community.org/3.20/en/sru.html#sru_search. I see there is a kohadocs.git to which Nicole contributes ( http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary), but do those changes still go through Bugzilla?
Does one clone the repository and just post the patches to Bugzilla and mark it as documentation? And then Nicole/RM does the merging from there?
I basically just want to add that searching “title” will use “index.dc.title” because the default set in pqf.properties is “dc”, and that you can use other sets by adding the prefix like “f bath.keyTitle=test” in yaz-client when using “querytype cql”.
But there’s heaps of other search documentation that I’d like to edit, so I figure I may as well get up to speed on the procedure! I’ve been saying for years that I should contribute to the documentation, so maybe I should put my words where my... words are!
David Cook
Systems Librarian
Prosentient Systems
72/330 Wattle St
Ultimo, NSW 2007
Office: 02 9212 0899
Direct: 02 8005 0595
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
-- Tomás Cohen Arazi Theke Solutions (http://theke.io) ✆ +54 9351 3513384 GPG: B2F3C15F
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
Hiya! The description of the koha-docs mailing list says "This list will be used to send patches to the documentation manager. Please send all documentation patches to this list for review." I know I have sent documentation patches to this before, and Nicole has pushed them. http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs The easiest thing might be to ask Nicole on IRC, I guess. Best regards, Magnus On 20 April 2016 at 15:33, Barton Chittenden <barton@bywatersolutions.com> wrote:
Agreed.
There is a 'Documentation' category in bugzilla. The documentation is in docbook format; I'm sure that you could supply patches, or I'm sure that Nicole would be happy to make edits if you supply the text.
--Barton
On Wed, Apr 20, 2016 at 8:59 AM, Tomas Cohen Arazi <tomascohen@gmail.com> wrote:
I think it should follow the regular BZ workflow.
2016-04-20 4:00 GMT-03:00 David Cook <dcook@prosentient.com.au>:
Hey all,
What’s the procedure for updating Koha manual documentation?
I’d like to expand on http://manual.koha-community.org/3.20/en/sru.html#sru_search. I see there is a kohadocs.git to which Nicole contributes (http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary), but do those changes still go through Bugzilla?
Does one clone the repository and just post the patches to Bugzilla and mark it as documentation? And then Nicole/RM does the merging from there?
I basically just want to add that searching “title” will use “index.dc.title” because the default set in pqf.properties is “dc”, and that you can use other sets by adding the prefix like “f bath.keyTitle=test” in yaz-client when using “querytype cql”.
But there’s heaps of other search documentation that I’d like to edit, so I figure I may as well get up to speed on the procedure! I’ve been saying for years that I should contribute to the documentation, so maybe I should put my words where my... words are!
David Cook
Systems Librarian
Prosentient Systems
72/330 Wattle St
Ultimo, NSW 2007
Office: 02 9212 0899
Direct: 02 8005 0595
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
-- Tomás Cohen Arazi Theke Solutions (http://theke.io) ✆ +54 9351 3513384 GPG: B2F3C15F
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
Sorry for my delay all. Here's the wiki page on this: https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual Patches are submitted to the Docs list. Thanks Nicole On Thu, Apr 21, 2016 at 2:39 AM, Magnus Enger <magnus@enger.priv.no> wrote:
Hiya!
The description of the koha-docs mailing list says "This list will be used to send patches to the documentation manager. Please send all documentation patches to this list for review." I know I have sent documentation patches to this before, and Nicole has pushed them. http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-docs
The easiest thing might be to ask Nicole on IRC, I guess.
Best regards, Magnus
Agreed.
There is a 'Documentation' category in bugzilla. The documentation is in docbook format; I'm sure that you could supply patches, or I'm sure that Nicole would be happy to make edits if you supply the text.
--Barton
On Wed, Apr 20, 2016 at 8:59 AM, Tomas Cohen Arazi <tomascohen@gmail.com
wrote:
I think it should follow the regular BZ workflow.
2016-04-20 4:00 GMT-03:00 David Cook <dcook@prosentient.com.au>:
Hey all,
What’s the procedure for updating Koha manual documentation?
I’d like to expand on http://manual.koha-community.org/3.20/en/sru.html#sru_search. I see
a kohadocs.git to which Nicole contributes (http://git.koha-community.org/gitweb/?p=kohadocs.git;a=summary), but do those changes still go through Bugzilla?
Does one clone the repository and just post the patches to Bugzilla and mark it as documentation? And then Nicole/RM does the merging from
On 20 April 2016 at 15:33, Barton Chittenden <barton@bywatersolutions.com> wrote: there is there?
I basically just want to add that searching “title” will use “index.dc.title” because the default set in pqf.properties is “dc”,
and that
you can use other sets by adding the prefix like “f bath.keyTitle=test” in yaz-client when using “querytype cql”.
But there’s heaps of other search documentation that I’d like to edit, so I figure I may as well get up to speed on the procedure! I’ve been saying for years that I should contribute to the documentation, so maybe I should put my words where my... words are!
David Cook
Systems Librarian
Prosentient Systems
72/330 Wattle St
Ultimo, NSW 2007
Office: 02 9212 0899
Direct: 02 8005 0595
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
-- Tomás Cohen Arazi Theke Solutions (http://theke.io) ✆ +54 9351 3513384 GPG: B2F3C15F
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
_______________________________________________ Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
Koha-devel mailing list Koha-devel@lists.koha-community.org http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
participants (5)
-
Barton Chittenden -
David Cook -
Magnus Enger -
Nicole Engard -
Tomas Cohen Arazi