add1sun started this at http://drupal.org/node/109114 with an excellent proposal for organizing the patch docs in the d.o handbooks (see below). now that the patch spotlight is underway, i'd like to propose a more thorough restructuring of the patch-related docs, building on what add1sun laid out. i know we normally don't use "top-level" path aliases, and prefer to prefix with "/handbook", but in this case http://drupal.org/patch is already pointing to a node buried deep in the patch-related docs. so, we should take advantage of that, and build a path (and book) structure on top of that which makes sense. in some cases (e.g. http://drupal.org/patch/review) we're already doing that. let's finish the job.
add1sun's original proposal
- 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
Extra changes on top of add1sun's proposal
- http://drupal.org/node/325
- current:
- path: /patch
- handbook: deeply nested under: Developing for Drupal » Contributing to Development » Patches
- title: HOWTO: Submit patches for Drupal - proposed:
- path: /patch
+ title: Patches
+ handbook: moves up to the root of "Developing for Drupal"
this would become the root, and we should lift a lot of content and all the children pages from #22568...
- current:
- http://drupal.org/node/22568
- current:
- path: [none]
- title: Patches
- handbook: Developing for Drupal » Contributing to Development - proposed:
- path: /patch/submit
+ title: Submitting patches
+ handbook: Developing for Drupal » Patches
- would be the root of submit-related child pages, an would take content from #325, plus whatever other re-org, re-shuffling we want.
- current:
- http://drupal.org/node/323
- current:
- path: /diffandpatch
- handbook: deeply nested under: Developing for Drupal » Contributing to Development » Patches
- title: HOWTO: Create patches - proposed:
- path: /patch/create
+ title: Creating patches
+ handbook: Developing for Drupal » Patches
+ add a php page that does a redirect from /diffandpatch to /patch/create (since i guess 2 paths for the same page is bad for search ranking).
- current:
- Add the "Patch spotlight" page
full proposal
http://drupal.org/patch (http://drupal.org/node/325)
"Patches"
- http://drupal.org/patch/background (http://drupal.org/node/70745)
"Background: the basic concept of Diff and Patch" - http://drupal.org/patch/apply (http://drupal.org/node/60108)
"Applying patches"- Common problems
- Apply Patches on MacOS X
- Apply patches in Windows
- http://drupal.org/patch/review (http://drupal.org/node/772)
"Reviewing patches"- HOWTO: Set up test env to review
- Other resources for reviewing
[new page, with links to info on code style, security, benchmarking, unit testing, usability, coder.moule, etc, etc].
- http://drupal.org/patch/create (http://drupal.org/node/323)
"Creating patches"- Create patches in MacOS X
- Create patches on Windows
- http://drupal.org/patch/submit (http://drupal.org/node/22568)
"Submitting patches" - http://drupal.org/patch/spotlight (http://drupal.org/node/132970)
"Patch spotlight"
[Maybe this should be moved up right after "Reviewing"]
Comments
now implemented
after glowing reviews by webchick and add1sun, the following is now reality in the d.o handbooks. yay. ;)
add1sun will now work on editing the content to remove duplication, and have the information flow make more sense. but, at least the node, book, and path structure is finally sane.
Help review new docs
Hey all, now that the restructuring is done the next step is a rewrite of the docs themselves. There are currently two issues where I've started this and if folks (especially people new to patching!) could review and give feedback in the queues, that would be awesome.
Rewrite Creating Patches
Rewrite Submitting Patches
Learn Drupal online at Drupalize.me