Outline for Drupal 7 Site Building quick start guide

Events happening in the community are now at Drupal community events on www.drupal.org.

The Docs Team has put in a proposal to attend the Google Summer of Code Docs Summit/Sprint in October 2011. This conference includes a sprint, and we decided that we would propose building:

A quick start guide to building a Drupal 7 site (with core Drupal and contributed modules), which we've identified as a missing piece in our official Drupal documentation. (We had a beginner's suite building guide for Drupal 5, which was updated somewhat for Drupal 6, but it has issues and needs to be totally rethought.) This new quick start guide would use a fictitious company web site as an example, and go through all of the steps necessary to build a Drupal site (after the initial installation of Drupal -- we already have good documentation on that part). We would then link to this quick start guide from our Drupal documentation home page, and from other pages on Drupal.org (our intent would be for this to live on-line on drupal.org, and to be a fairly prominent piece of documentation, maintained going forward in new versions of Drupal).

What I'd like to do here is make an outline, so we're ready to get to work on this when we arrive (if our proposal is accepted).

Notes

These were taken from the discussion on http://groups.drupal.org/node/161644, in no particular order.

Issues with current cookbook

Structure ideas for new guide:

[jhodgdon] I'm thinking that this should be DITA structured, and maybe form the first topics for the new help.drupal.org? So if we introduce concepts, we make concept topics, and if we demonstrate tasks, we make task topics. I'll be expanding on this idea shortly...

Content ideas for new guide:

  • Use a coherent example of a web site for a single fictitious company as a guiding principle
  • Drupal 7 only
  • Concentrate on the core objectives and avoid talking about common problems, tips and tricks, etc.
  • Don't include migrating content - just concentrate on building a new site from scratch
  • (Lee): It might be useful to think of the chapters in terms of major objectives, for example:
    -- The first things to do after installing Drupal
    -- Installing and configuring the most common modules (Views, etc.)
    -- Downloading a contrib theme and making some changes to it
    -- Creating some interactive features like forms and reports.
    -- Managing users and content
  • See http://drupal.org/node/1053484 (issue)

Title Suggestions

  • Site Building in Drupal 7: A Quick Start Tutorial for Beginners

Outline

  1. About this tutorial: who it's for, what it does and doesn't cover, what you need to get started (installation and username/password) etc.
  2. First steps: Logging in to your site, a bit about navigation, changing your password, setting the name of the site etc.
  3. (etc.)

Comments

A similar tutorial that could be reused

itangalo's picture

I made a tutorial that is pretty close to what's discussed here – a site for online documentation built from scratch to kind of complete. ("Kind of" because there is no theming, and it is of course also always possible to add more features.) It was built to show/teach/learn Drupal 7 from the basics, along with the Views, Flag, Rules, Page manager and Panels modules, and can be found here: http://nodeone.se/node/845

It is built as 20 exercises, each being a separate user story that brings some new functionality to the website. They can be done in sequence, or each exercise separately with some minor preparation work. Each exercese has descriptions, screencasts, a downloadable feature with the completed setup, links to related documentation, etc. (Some more words on the exercise suite can be found at http://nodeone.se/blogg/23-exercises-for-site-editors-and-drupal-beginners

I'd be more than happy to include this tutorial/exercise suite on drupal.org, if you find it useful. (If so, an overall description for the planned website should probably be added, since it currently has introductions for each separate exercise only.)

//Johan Falk
**
Check out NodeOne's Drupal Learning Library! 150+ screencasts and exercises, for Drupal introduction, advanced configuration, and coding.

Sounds good!

jhodgdon's picture

I will check that out -- thanks for your contributing spirit!

If you can remove comments

aspilicious's picture

If you can remove comments from the new "cookbook" do it :) ...

Removing comments

jhodgdon's picture

We would like to remove comments from all drupal.org doc pages. Someone needs to take care of a few infrastructure issues first though.

If this gets built on a new web site, rest assured we won't have comments. :)

caution - removing comments

Sree's picture

Before we remove the cmments - first we need to check for any valuable tips within them, then embed those tips within the main pages then remove the comments.

Sree

Yes Sree - comments will be

arianek's picture

Yes Sree - comments will be "closed" but not removed until they are rolled in, not to worry.

@Jhodgdon - please do consider space for Itangalo's work - I've been reading his book today, which is what some of the tutorials are for, and they could easily fit this guide. Too bad we can't just buy rights to the book and use it! ;)

About using screencasts for documenting

bisonbleu's picture

As I was reading the first message of this thread, I thought to myself "why not use screencasts when & where possible...?" Then I saw Johan's post. I'm a big fan of nodeone.se's series of screencasts.

Question: Are there rules/policies/concerns/best-practices for adding links to screencasts when we document a topic, a module or whatever?

I recently edited the uc_recurring documentation page. As I was doing it, I wondered if it wouldn't be easier to record a simple screencast using Jing. Chances are, the overall experience would be greatly enriched. What about language? Maybe subtitles...?

In my mind, this could speed up the documentation process quite a bit or at least quickly provide basic help until documentation is made available.

Thoughts? Process? :-)

Being. Knowing. Sharing. Ip Man

Personally I'd be open to

arianek's picture

Personally I'd be open to adding top notch screencasts to the docs, but there are two hangups as far as infra goes:

1) I believe only site admins (note docs admins but full site admins) can embed videos or edit pages with videos embedded, as they require using Full HTML format. (Of course we could get around that by using emfield, but getting new modules onto D.o is not so easy.)

2) The current (albeit loose, and currently broken for videos) rule about any content on D.o is that it be hosted on D.o, so if videos were to become more widely used, I'm not sure if they would need to be hosted on D.o. If so, that is a huge infra request, so likely not to happen.

In the meantime, linking to videos posted elsewhere is the go-between.

Documentation

Group categories

Event type

Post type

Group notifications

This group offers an RSS feed. Or subscribe to these personalized, sitewide feeds:

Hot content this week