These are responses to logickal's work on the Site Builder's Guide (http://drupal.org/node/803746#code)
1. I would drop the rebase and stash sections. Those are basic git *skills* and not about sitebuilding. References to them might be OK. Probably don't need to go into annotated tags, for the same reason. And you've wisely stayed away from submodules. I think you can point to other workflows, but keep this one simple.
2. The .gitignore has made it into core (8.x) and will probably soon be in 7.x, so you may want to talk about how to modify it rather than how to make one. #917492: Add a sensible .gitignore file landed in D8 today.
3. One thing to consider that's even easier, and only a slight modification: Don't even maintain a Drupal.org remote. Just have your project remote and use drush (without any git management) to update it. The same thing that you're doing with modules.
4. Along those lines, it might be nice to have a quick introduction to explain what you're trying to accomplish. Here we're just keeping the *project* under git control, and not really trying to integrate it with the development of Drupal or contrib.
Nits: I think links to the various technologies mentioned might help people. Gitosis, etc. You're probably glossing over something that people think is black magic: Setting up an authoritative repository. Maybe some links to how to do that are in order (or how to use github).
I think it's totally legitimate to use github as a repo for most sites, BTW. You might want to use that as an example instead of a local filesystem-based example. I *don't* think you should teach how to set up gitosis, but pointing them to resources on how to do these things would probably be good.
Overall, I think this is a quite excellent page. Let's make sure to keep it simple and not let it get out of hand :-)
Thanks for the great work!
Comments
Comment #1
rfayI should have mentioned that this feedback is for the current "owner" of http://drupal.org/node/803746, logickal.
Comment #2
eliza411 commentedSee original issue: #1112694: Rewrite Site Builder's Guide
Comment #3
logickal commentedGreat responses, and echoing some thoughts I've had already. Assigning to myself to continue editing. Thanks!
Comment #4
logickal commentedJust an update before I head out of town - I've addressed #1 and linked to some of the hosting solutions. Still working on streamlining and implementing the other points, hope to have it all updated next week
Comment #5
mike stewart commentedI've been following the development of this document for about two months... awesome job! ... and just found the issue here thanks to google (while searching for the actual post).
I'd like to comment on @rfay's suggestions above. I totally agree with a Keep It Simple Stupid (KISS) approach. I think for the most part this has already been accomplished. However, I'd love to see a sub-handbook-page that details a more advanced workflow: workgroup approach. I'd be willing to volunteer to add it.
However, regarding point #3 -- I think I'd favor using git for the simple workflow of updates vs drush update. The main reason is it doesn't require the setup of Drush. Just something else to be done which could get in the way of updating. It also comes with the benefit of added security that may not be as obvious when using Drush. (Due to the way git works (hashes) an update from git can be confirmed to be identical as the code on Drupal.org).