[documentation] [Documentation task] Reorganizing the Patch docs
add1sun
drupal-docs at drupal.org
Sat Jan 13 19:29:54 UTC 2007
Issue status update for
http://drupal.org/node/109114
Post a follow up:
http://drupal.org/project/comments/add/109114
Project: Documentation
Version: <none>
Component: Developer Guide
Category: tasks
Priority: normal
Assigned to: Anonymous
Reported by: add1sun
Updated by: add1sun
Status: active
Ack, sorry, I really should have a habit of hitting preview first.
let's try that structure one more time:
* Background: basic concept Diff & Patch
* Applying and Reviewing Patches
* HOWTO: Apply patches
* Common problems
* Apply Patches on MacOS X
* Apply patches in Windows
* HOWTO: Set up test env to review
* Tips for reviewing patches
* HOWTO: Submit patches
* HOWTO: Create Patches
* Create patches in MacOS X
* Create patches on Windows
add1sun
Previous comments:
------------------------------------------------------------------------
Sat, 13 Jan 2007 19:20:58 +0000 : add1sun
This is my first real foray into docs work so let me know if I'm going
about this incorrectly.
I am learning how to do patches and patch review and I find the
Handbook's current docs a bit confusing. While pages do refer to other
pages, the order in the menu and the way everything is broken out made
it confusing. I want to propose a little reorg of the existing docs and
then I will also be working on improving some of the pages themselves
(notably Create patches and Submit patches sections) so it is a smoother
ride for newbies like me. Here is my proposed new ordering, this all
goes under Contributing to Development > Patches:
Background: the basic concept of Diff and Patch
Applying and Reviewing Patches
HOWTO: Apply patches
Common problems
Apply Patches on MacOS X
FileMerge
Apply patches in Windows
Cygwin
Patch
UnxUtils
HOWTO: Set up a test environment to review patches
Tips for reviewing patches
HOWTO: Submit patches for Drupal
HOWTO: Create Patches
Create patches in MacOS X
Create patches on Windows
CVS
Several win diff programs
Subversion
TortoiseSVN
UnxUtils
WinCVS
WinMerge
I have grouped Applying and Reviewing since you need to know how to
apply them in order to review them but if folks think it makes more
sense to separate them, that would still flow I think (that is have as
majors: Background, Applying patches, Reviewing patches, Submitting
patches).
Thoughts, comments, rotten tomatoes?
More information about the documentation
mailing list