Omega 3.x Documentation Sprint - #Drupal-Omega IRC

Posted by Anonymous on September 27, 2011 at 10:49pm

Start:

2011-10-03 10:00 America/New_York

Event type:

Sprint

Documentation for Omega 3.x currently exists in a wiki, the official handbook (work in progress) and plans for an external (non-d.o) site with an approximate ETA of 2 months. In the meantime, Omega 3.x truly needs a documentation make-over. Please join us for the upcoming doc sprint which seeks to accomplish and is not limited to the following:

Develop community consensus for long-term Omega 3.x documentation objectives.
Cull the various existing documentation sources and distill them into one handbook on d.o.
Present the following information in a single location with the intent of making it easier to get started using Omega:

Compile usual suspect questions

Things for designers to consider when designing for an Omega site

Installation (install omega, enable helper modules, create a subtheme)

Configuration basics

Define the theme settings options (what do these things do?)

Compile a list of "gotchas" i.e. disappearing logo

Delta how-to

Context how-to

If you have questions, comments or suggestions please leave them in the comments section below. The sprint agenda will be influenced by the discussion in this thread, @argus outline, the wiki & discussion in IRC. The most active and current information and happenings are occurring in #drupal-omega on IRC. Please join us.

Please add your name to the signup list even if you aren't sure you are going to be able to attend. This list will be useful for organizing future sprints.

Comments

Hear hear. . . .

Posted by jpw1116 on September 27, 2011 at 11:04pm

This is a great initiative.

One of the easier ways to convey the sometimes-new nomenclature in Omega (Sections/Zones/Regions) may be graphically—a picture’s worth a kiloword.

Ben Hosmer’s great diagrams at http://www.radarearth.com/content/beginning-drupal-7-theming-omega should be the foundation for that. They are substantially complete; we just need to compare to the latest Drupal release to check.

Some coverage of Omega Tools/GUI and integration with Sweaver would also be smart.

Again, the sprint is a super idea. I will gladly chip in where/when possible.

I spent a few minutes with

Posted by banghouse (not verified) on September 28, 2011 at 1:17am

I spent a few minutes with sweaver recently. I think it's fantastic. Unfortunately I had some issues that may have been Omega related. I'll have to revisit it and get back to you with specifics.

Documenting the "helper" set of modules is definitely on the agenda. I'm still seeing cases where some users aren't installing Omega Tools, Delta and Context and for that I made this: http://www.youtube.com/watch?v=Ky_FYVxeOGc . The Omega project page will be getting an update relatively soon so that should also help with this kind of thing as well.

I agree images and videos are very useful. We'll do what we can to make sure all of those resources are easy to find.

Thanks for the feedback. Hope we'll see you in IRC.

You're right. . . .

Posted by jpw1116 on September 28, 2011 at 7:41pm

I'm pretty sure that Sweaver has been sweating with Superfish enabled . . . I can't recall exactly.

Thank you for the vote toward the helper modules.

Yeah, I'll do my best to show up on IRC. We're setting up our first D-camp here in WNY and it's crunch time.

-John

BTW, I'm glad Ben's diagrams are linked in the Wiki . . . that's great.

Yes all the resources in the

Posted by banghouse (not verified) on September 28, 2011 at 8:16pm

Yes all the resources in the wiki will be available in a handbook page after the sprint. Until then if there is anything not there that should be please add it. Good luck with WNYCamp!

diagrams are on wiki, though in an obscure place

Posted by dhalbert on September 28, 2011 at 6:04pm

Ben Hosmer’s great diagrams at http://www.radarearth.com/content/beginning-drupal-7-theming-omega should be the foundation for that. They are substantially complete; we just need to compare to the latest Drupal release to check.

These diagrams are in the wiki at Styling Guides and Diagrams of Zones/Regions, linked from the upper page CSS Weights, Default Loading Order and Overrides. See the This Page link at the bottom of that page. They should probably be made more prominent. I had previously edited the text version a bit to make it more compact and fix some omissions.

Good initiative!

Posted by Argus on September 28, 2011 at 5:28pm

I will try to attend.

I'm all in for this. Let's

Posted by Cellar Door on September 28, 2011 at 7:50pm

I'm all in for this. Let's use this space to discuss and decide on a direction and outline for the documents prior to the event. This way we can stay focused and create relevant documentation without getting too off track.

My vote is for the initial documents to be beginner based. Teaching the fundamentals etc. without getting into anything too complex. This will alleviate many of the simple questions that come up here or in IRC and will allow us to focus on how to describe some of the more powerful things Omega can do. Thoughts?

Drupaler and Mobile Ninja
Cellar Door Media - Beautiful Mobile Solutions

I'm in agreement that the

Posted by banghouse (not verified) on September 28, 2011 at 9:26pm

I'm in agreement that the highest priority is Beginner level documentation. Removing barriers to entry, points of confusion and gotchas for beginners is paramount. Intermediate and Advanced level documentation is important and deserves attention and will get it in due time. But given that we are only sprinting one day AND starting rather late (for some) I think we should focus on Beginner level docs until we are all satisfied that Beginners have been addressed thoroughly and efficiently.

We can always schedule another sprint for advanced documentation if need be. And chances are we will. Also please keep in mind that this documentation is to be a skeleton framework for the more visually complex documentation coming down the pipe from Development Geeks/Theme Geeks (ETA 2 months). So though we may want screenshots and videos that will all come later. That said, I think a comprehensive and up to date resource page is vital and should also be on the agenda.

There is ofc the issue fubhy

Posted by Argus on September 28, 2011 at 8:40pm

There is ofc the issue fubhy started Rewrite the Omega documentation for Omega 3.x - A discussion about the topics that we should cover.

At some point I tried to organize all suggestions: http://drupal.org/node/1183512#comment-4600982

Perhaps that could be of use.

@Argus - We have had numerous

Posted by banghouse (not verified) on September 28, 2011 at 10:38pm

@Argus - We have had numerous discussions re:docs in IRC where there has been consensus that your outline is valuable. Rest assured it will be heavily referenced. Also thank you for the effort. And please join us in IRC pre-sprint if you can as much of what is guiding this effort is being discussed there and then brought here.

I've never participated in a

Posted by rggoode on September 28, 2011 at 9:26pm

I've never participated in a Sprint before. I'm relatively new to Drupal, but this seems like a good place where I might be able to finally "give back to the community"

I don't know how a sprint works though... Any ground rules? or just show up? (if I can)

Roger

_________________

Art has gone to the dogs
GoodeGallery.com

Hi Roger, Yes please do join

Posted by banghouse (not verified) on September 28, 2011 at 9:39pm

Hi Roger,

Yes please do join us! You can /join #drupal-omega on Freenode:IRC anytime to be involved in the real-time conversations we are having everyday about Omega. Or you can jump into the conversation on this thread to help us outline our agenda for the sprint. Preferably both. As for the act of sprinting, this is a great write-up.

adding custom javascript - snippet

Posted by chaquea on September 29, 2011 at 9:06pm

Making a note on how to add custom javascript to the omega themes, by template.php (drupal_add_js(drupal_get_path('theme', 'YOURTHEME') . '/YOURJS', array('scope' => 'header','weight' => 1));) or by YOURTHEME.INFO

Sorry for such a newby question but.

Posted by dshumaker on June 23, 2012 at 4:57am

But do I just verbatim add your code or do I need it in a

function omega_alpha_preprocess_html(&$vars) {

type of function??

gotchas

Posted by bjcooper on September 30, 2011 at 8:21pm

I'm pretty new to Drupal, so I've got a little first-hand experience with 'gotchas'. :)

Recently, I was trying to add a new region in an Omega-3.x subtheme, but I couldn't get it to work for the life of me. I figured I had to manually add the region to the zones array in the subtheme.info file, as in Omega-2.x, but couldn't find where the heck to do that. Everyone was saying that unassigned regions should be assigned to zones through the admin UI, but I just couldn't get my new region to show up in the Zone and Region Config!

After about three hours of digging, I was chatting with banghouse on the #drupal-omega channel and realized I'd closed my region declaration with a curly brace instead of a square bracket. Doh.

Doc Sprint REMINDER: 10pm/9pm

Posted by banghouse (not verified) on October 3, 2011 at 9:11pm

Doc Sprint REMINDER: 10pm/9pm CST Tonight! #drupal-omega

Theme porting

Posted by afear on October 3, 2011 at 9:45pm

Another usual suspect question might be: What's the general process for moving my theme from Zen (or non-omega base themes in general) to Omega?

+1

Posted by Ilya1st on October 3, 2011 at 10:19pm

Hi. In Russia it's 2:13 am and I'm sorry I cannot join you today, but I use omega and I want take part in future cause omega looks like best base theme for next two years

Me too

Posted by iainH on October 3, 2011 at 10:34pm

Be glad to help with docs at some point. Is it possible to arrange a European-friendly time for a future omega doc sprint or similar? Am working towards completion of two omega-based sites and would like to contribute from experiences with Context and Delta which is a truly useful combination with Omega

Ilya1st - iainhouston : Sorry

Posted by Cellar Door on October 4, 2011 at 12:56am

Ilya1st - iainhouston : Sorry for the non Euro-friendly timing on this. The docs will be open to editing after the sprint so please be sure to add your inputs/edits to the docs whenever possible. In the future we'll get a time that works better globally (if there is such a thing) and hopefully include our Euro brothers/sisters as well.

Drupaler and Mobile Ninja
Cellar Door Media - Beautiful Mobile Solutions

The general planning and

Posted by banghouse (not verified) on October 4, 2011 at 1:08am

The general planning and timing arrangement for this sprint was done in IRC in #drupal-omega. It's just easier to coordinate a hundred cats in real-time than in a time-delayed threaded discussion. So we invite anyone that is here to also be there with us in order to ensure everyone has a voice in the decision making process.

Omega Doc Sprint - Part

Posted by banghouse (not verified) on October 19, 2011 at 3:34am

Omega Doc Sprint - Part 2

http://groups.drupal.org/node/183469#new

Join us if you can. We hope to complete the basics portion of the docs handbook in this sprint. The next phase for docs will be intermediate and advanced sections.