Here's the idea, if you have any comments please do.
Task title
Write 'first steps' tutorial for Panels 2
Task description
Panels 2 is a new module still underdevelopment that allows even non-developers to very easily style their page, add blocks, shift nodes, place views – and all through a slick UI. This one is definitely going to change the way people will react to the word 'theme' , as PHP knowledge is not needed – it can help – but it's not needed.
The tutorials should give a newbie to Panels an understanding what it does and how to do it, although it shouldn't approach people who are complete newbies in Drupal (i.e. not needed to explain what node is).
A good tutorial is consisted of text and images that will accompany it. Images should make sure there isn't to much information, and if needed focus the reader through clear markings. The text should be short enough not to be boring, but it's intended to people not robots, so please – spice it up a bit.
Expected work
There should be 4 tutorials (3 new and editing an existing one).
Tutorials topics should be:
1. Creating an 'about us' – include a custom content and a block with who's online and latest comments
2. Creating a mini panel – Create a mini panel that shows a View and passes an argument to it (i.e. the 'Send Argument' checkbox is enabled). This will also include an export of the Views.
3. Overriding the node view - Creating 'own display' in the context tab for Story and one for page, i.e. different panel for different content types.
4. Overriding the node edit – Edit http://drupal.org/node/201916, that misses some images mostly.
Task should be delivered by creating a book contents on the drupal.org site.
Every tutorial should have 2-5 images.
Every tutorial should have an export of the panels.
Resources
Panels 2 page - http://drupal.org/project/panels
Download Panels 2 (alpha 14) - http://drupal.org/node/194291
Panels 2 Dev version (We should keep an eye on it, to see Merlin didn't change the layout, so images will still fit) - http://drupal.org/node/128199
Initial tutorial, which misses some images - http://drupal.org/node/201916
Primary contact
Amitai (Amitaibu) - http://drupal.org/user/57511
Estimated time
3 days.
Comments
Comment #1
amitaibuComment #2
merlinofchaos commentedSome notes for the student who accepts this task:
yoroy recently submitted new icons (yesterday, in fact) that I have not yet installed (though by the time this is assigned I may have). See: http://drupal.org/node/179690
For #2, I would prefer if the tutorial used the 'context' system, as that is the single most important concept to demonstrate to users. Everything in tutorial #1 will likely be obvious to most, but the context system is much less obvious, and extremely powerful, and tutorial #2 is an excellent way to demonstrate context from both sides (creating a context and a mini panel which uses a context).
This totally gets my +1.
Comment #3
michelleI would love it if the tutorial explained that whole "own display" and "default display" thing because I don't get it.
Subscribing to track this... I'll review it when it's done. I'm pretty heavy into panels 2 right now.
Michelle
Comment #4
add1sun commentedOk, this has been made official. Changing name and project info.
GHOP Google issue
Comment #5
add1sun commentedClaimed by birdmanx35
Comment #6
amitaibu@merlin, @add1sun, @birdmanx35
A thing that I didn't want to happen just happened - I took a responsibility, but I have to pass it on. since I'm going for a long trip and actually the computer/ net is no longer available.
I'm terrible sorry about it, especially because I really wanted it to happen. Honestly when I posted the ghop on 18-DEC I didn't think the first input will not even come until 31-DEC.
So again really sorry about it! I wish you a happy new year and me a nice trip :)
Comment #7
michelleI mentioned a couple weeks ago that I'd review this when it's done. Since Amitaibu is leaving, I'll add that I'm available for questions as well. I'm not a panels 2 expert but I've been working with it enough that I know more than the average Drupaller about it. I don't have tons of free time but I will do my best to be available for this.
Michelle
Comment #8
add1sun commented@Amitaibu,
That's OK, I think we have a number of folks who can step in and mentor this. I'm willing to do that as well. Re: the dates, yeah the contest is open until February so any task may not be done til February, if completed at all. I think birdmanx35 has got a good start now so we'll make sure he gets the support he needs.
Thanks for coming up with the task and getting it started. And have fun on your trip!
Comment #9
amitaibuThanks Michelle and add1sun!
Comment #10
birdmanx35 commentedOkay, well here is what my approach thus far has been:
-Work through the existing tutorial on the development version, to see it's weak points and attempt to understand how Panels works. I've got a node edit override working now, and I've done some cleaning up of the old tutorial, which is mostly obsolete after alpha14 and the new dev version.
-Attempt to try the material for the first tutorial. This is done.
-Attempt to try the material for the other two tutorials- I am presently working through those.
When I am done understanding Panels 2 a bit more, and the Panels beta is released (slated for today, i think), I will create the tutorials and screenshots for each task, and revise the fourth to be much better and cleaner. Thanks SO MUCH everyone for their patience and help, especially Merlin and Amitai.
P.S. Amitai, I didn't know you were on vacation, so feel free to stop emailing me if you are busy ;)
Comment #11
birdmanx35 commentedOkay, the existing tutorial (http://drupal.org/node/201916) has been revamped, and I've created one of the other three (http://drupal.org/node/205376).
Merlin's reviewed the revised version of the existing tutorial already, but has not gotten to the latter. Please revise when you get a chance.
Comment #12
merlinofchaos commentedRevised item 2:
2. Creating a mini panel – Create a pane that shows a View and uses a context as an argument.This will also include an export of the View.
Comment #13
dvessel commentedsubscribing.. I need to get up to speed on panels. :)
Comment #14
birdmanx35 commentedJust talked with Merlinofchaos, and the revised item 2 should be further revised: I don't need to use a mini panel.
Comment #15
birdmanx35 commentedOkay, I am done with this task (although I will fix whatever problems there may be). You can find the nodes at:
http://drupal.org/node/205376 - Basic Text Layouts (#1)
http://drupal.org/node/206792 - Front Page w/ Views + Panels 2 (#2)
http://drupal.org/node/206185 - Node Override (#3)
http://drupal.org/node/201916 - Node Edit Override (#4)
Comment #16
keith.smith commentedHeh. I read through several of these last night without realizing that it was a GHOP task and thought "Man, this is some really nicely done documentation; I wonder who did this."
(And, for the record, I also thought "Man, this is a really slick module".)
Comment #17
birdmanx35 commentedNow there's a review ;)
Comment #18
aclight commentedThese look very good. I have a few minor comments:
A.) For the first time you mention Panels 2 on each page, I would provide a link to the module's project page. The same goes true for Views and any other modules you mention.
B.) You might want to set the image attachments not to be listed on the pages so the pages themselves look a little cleaner.
C.) When you give menu link paths, you probably should follow the handbook guidelines at http://drupal.org/node/22299, specifically section 4.
I don't have time right now to read through all of these in detail, but at first glance these look very good. Very nice work!
I'll keep the status as code needs review since my comments are minor.
Comment #19
yched commentedThe handbooks pages are very clear and helpful, great job !.
A few remarks :
http://drupal.org/node/205376 : I do think the
<a>is accepted by default in the 'Filtered HTML' input format, so advising to use 'Full HTML' shouldn't be needed.http://drupal.org/node/206792 : users won't find their views available as panels content unless they :
- explicitely 'panels-enable' their views using the 'panels views' menu item (probably preferred)
- OR enable 'panels views legacy' module, which exposes all available views as panels content.
Comment #20
birdmanx35 commentedaclight: Thanks very much. I'm adding those suggestions into the page atm.
I'm not sure if I did the menu items right; feel free to go in and fix them if you have documentation team skillz. Then I'll see how you did it.
I picked up a few other minor errors (or non-conformities to the standard) that I put in.
Comment #21
birdmanx35 commentedI've just incorporated yched's suggestions. I wasn't even aware of the latter suggestion, so thanks very much!
Comment #22
michelleI read through them all and they look very good. The only nitpick I have is the word "let's" is used way too much. Now and then is ok to make them friendlier, but one of the tuts had it on every line for a while. It's a small thing but I can't find any big issues. The docs are better than a lot of what we have in the handbook. :) I think this is RTBC but I don't know if there's some protocol on who should pull the trigger.
Michelle
Comment #23
merlinofchaos commentedIMO Michelle is qualified to say these are RTBC. =)
Comment #24
birdmanx35 commentedJust eliminated 90% of the let's. Sorry if it's still too friendly.
Comment #25
michelleLOL! I don't think iit was "too friendly", just repetitive. Saying "Now, let's add some content" is nice and approachable. Saying "Let's click the button" just seemed over the top. Hope that makes sense. I did a quick skim and it looks fine now. Only thing I see is http://drupal.org/node/205376 step 7 is missing an image. Otherwise, looks good.
Michelle
Comment #26
birdmanx35 commentedYep, fixed that. I typed "files/" instead of "/files".
Comment #27
birdmanx35 commentedYep, fixed that. Silly typing errors.
Comment #28
birdmanx35 commentedClosed as per: http://code.google.com/p/google-highly-open-participation-drupal/issues/...
Thanks very much everybody!
Comment #29
gracearoha commentedexcellent! blessings my son. you are the bird man.
i have been fumbling my way through panels. your documentation will be most helpful for n00bs like me.
Thank you!