sections out of order in wiki Documentation_Update_Instructions

[Chris Good]

Hi John,

 

I totally understand this is a work in progress, appreciate your efforts and
hope these suggestions will help.

 

I found a couple more things that could be improved:

 

1.       Many of the sections in Notes contradict the sections they are
supposed to refer to in
<http://wiki.gnucash.org/wiki/Documentation_Update_Instructions#The_Document
ation_Change_Process_--_What_and_How_it_happens> 2 The Documentation Change
Process -- What and How it happens. I think it would be a lot easier to
follow if the Notes were moved into the
<http://wiki.gnucash.org/wiki/Documentation_Update_Instructions#The_Document
ation_Change_Process_--_What_and_How_it_happens> 2 The Documentation Change
Process -- What and How it happens section so you don't have to jump back
and forth between them.

 

2.       1 section mentions creating patch by:

git format-patch master

which did nothing for me. I had to do as the other section says:

                                git format-patch HEAD^

 

I'm definitely a git newbie, but would it be worth adding:

                git format-patch -n 

to create patches for last n commits (I think that would work from my
reading of man page).

 

(I guess there are so many ways to do commits it is hard to recommend one or
two which would enable newbie's to easily do what they need to do)

 

3.       Subversion and trunk are still mentioned.

 

Regards,

 

Chris Good

 

From: Chris Good [mailto:chris.good at ozemail.com.au] 
Sent: Sunday, 1 March 2015 3:06 PM
To: gnucash-devel at gnucash.org
Cc: John Ralls
Subject: sections out of order in wiki Documentation_Update_Instructions

 

Hi John,

 

I think in http://wiki.gnucash.org/wiki/Documentation_Update_Instructions
there are 2 Step 8's and 2 step 9,s and they need to be rearranged:

 

 
<http://wiki.gnucash.org/wiki/Documentation_Update_Instructions#Step_8_-_Com
mit_your_Changes> 3.8 Step 8 - Commit your Changes

 
<http://wiki.gnucash.org/wiki/Documentation_Update_Instructions#Step_9_-_tes
t_documentation_in_Linux> 3.9 Step 9 - test documentation in Linux

 
<http://wiki.gnucash.org/wiki/Documentation_Update_Instructions#Step_8_-_bui
ld_the_HTML_version_of_the_documentation> 3.10 Step 8 - build the HTML
version of the documentation

 
<http://wiki.gnucash.org/wiki/Documentation_Update_Instructions#Step_9_-_Cre
ate_the_documentation_change_as_a_bugzilla_bug> 3.11 Step 9 - Create the
documentation change as a bugzilla bug

 

I think the 2nd step 8 should be before the first step 9 and the step no's
need to be made unique.

 

I haven't got a wiki account yet but I'm happy to try to fix if you wish?

 

Regards,

 

Chris Good

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 6091 bytes
Desc: not available
URL: <http://lists.gnucash.org/pipermail/gnucash-devel/attachments/20150301/695be877/attachment.p7s>