Contrib.social

Create Module Docs landing page standard

Open on Drupal.org →
Created on 29 April 2011, almost 14 years ago
Updated 26 March 2025, 30 days ago

Carolyn mentioned something I've been meaning to do for ages on #674474: Review and update D7 core module handbook pages → , so thought I'd start an issue. We should really create a standard/template for module docs landing pages (ie. the top level page for a particular module). This would provide a consistent guideline for core, and a suggested guideline for contrib as well.

URL alias should always be: http://drupal.org/documentation/modules/[project-name] - these are all set for core modules, and I do contrib ones as I find them.

Generally it should also loosely follow what's in the Help pages since that's where a lot of the D7 content came from. So something like:

[About/Intro]

Brief intro (not sure we need to actually put this as a heading like in Help we use "About").

Uses

Use cases, and what the module's config options are - optionally divided into D7 then D6 subsections.

Configuration

Configuration instructions and options. (Could be called "Implementation" - or would that be too technical?)

Technical Specifications for Drupal 7

Eg. from Carolyn for Block module based on Ken Rickard's Field UI docs work:

Core module: Yes.
Dependencies: None.
Related Modules: Dashboard.
Permissions: Administer blocks. Also see the API docs at block permission → .
API Documentation: block.admin.inc, block.api.php, block.install, block.module, block_test.module
Template files: block-admin-display-form.tpl.php, block.tpl.php
Other files: block.info, block.css, block.js
Database tables (4): block, block_role, block_custom, cache block. Also see the API docs at block schema.

✨ Feature request
Status

Postponed: needs info

Component

Policies and Procedures

Created by

🇨🇦Canada arianek

Live updates comments and jobs are added and updated live.
  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Comment 30 days ago →
    🇳🇿New Zealand quietone

    I think it is time to check in here an find out if there is any community support for the ideas in the issue summary.

  • Comment 29 days ago →
    🇮🇹Italy apaderno Brescia, 🇮🇹

    I think that we should use http://drupal.org/documentation/modules/[project-name] as path alias for a module's documentation page. It would avoid going to the project page and clicking on the documentation link given there.

  • Comment 28 days ago →
    🇳🇴Norway hansfn

    The only change since I last supported this 12 years ago is an S (and "documentation" = "docs"):

    httpS://drupal.org/docs/modules/[project-name]

    And the current URL for these pages are:

    https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/[project-name]

    which is terrible, and depends on me making sure people create doc guides with titles that match the project name. (I have discussed all of this other places.)

  • Comment 28 days ago →
    🇳🇿New Zealand quietone

    Is creating those URLs something for the drupal.org customization project?

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024