Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.The biggest stumbling block - by far - to creating a reasonable structure for the documentation is the fact that all the documentation for core modules is currently placed as child pages of the Core Modules page (http://drupal.org/handbook/modules). That means that there's no way to use this content without breaking the list of core modules.
What I'd like to do is add a two column table to the Core Modules page. One column would contain the module name (hyperlinked to the associated documentation), the other column would be blank except for those few modules that are not available in all versions (in those rows the cell would say something like "Version 5 only").
This would free up that content to be organized in a more logical fashion. In other words, there would be no more child pages of the Core Modules page as each chunk of module documentation could be moved to the context where its most relevant and useful .. and we'd still have a list of Core Modules for people who find that useful.
It would also address http://drupal.org/node/334316
Comments
Comment #1
add1sun commentedHm, so yes, I agree that a table would be better. Instead of making a manually created and updated table I'd rather move that to using views instead. Granted, it won't be updated often and we could move it over to a views list once we do the redesign, so I'm not saying we can't do it. I just want to point out that anytime we do "lists of stuff" on the site we need to earmark that for a view on the new site and think of it in those terms.
So table - cool. Where would the module pages go though? Where are the "most relevant and useful" places for them? I'd like to think that out here in the issue before we start shuffling things around. As noted in other issues, if we change how docs are related to projects in the redesign, how would we want core modules to be set up?
Comment #2
leehunter commentedYeah definitely we'd want this to be a view eventually.
In regards to where to put the core module documentation, it seems to me that there are two missing handbooks: Administration Guide and Site Building Guide. Some subjects overlap admin and site building, so there would need to be cross-references in a few places.
The Administration Guide is everything you need to know about the daily *running* of a basic Drupal site (not including the contrib module world). The reader may or may not know anything about actually building a Drupal site (they could be just a generic sysadmin guy in a big corporation who manages all sorts of different servers or it might be the same person who built the site) Just off the top of my head and in no particular order the topics might include:
- User Administration (user, profile and OpenID modules)
- Backing Up a Site
- Monitoring a site (dbLog, syslog, ping, Statistics and Update Status)
- Server Administration
- Managing Performance (Throttle)
- Managing Content (Content Translation module, Book module,
- cron etc.
The Site Building Guide would focus on setting up a new site or reconfiguring and extending an existing site. It might include topics like:
- Configuring Content Types
- Searching and Search engine optimization (Search and Path module)
- Configuring Menus and Blocks (Menu and Block module)
- Working With Taxonomies (Taxonomy module)
- Enabling User Input (Forum, Upload, Poll module)
- Building a Multilingual Site (Locale module)
- Automating Actions (Trigger)
- Site Recipes
- Communicating with external tools and sites (Aggregator and BlogAPI module)
Comment #3
johnnocComment #4
leehunter commentedComment #5
jhodgdonI don't see that this has been fixed?
Comment #6
jhodgdonComment #7
leehunter commentedActually it has pretty much disappeared as an issue. Most of the core module stuff has simply been moved to the most relevant context. The rest will be moved soon.