Improve project descriptions by using a template suggestion for the body field

Created on 31 August 2021, over 3 years ago
Updated 2 June 2023, over 1 year ago

Project Browser Sitebuilder Subcommittee - Project page template

Problem/Motivation

Project pages (module, themes, distros) across drupal.org are not consistently formatted. Many pages lack key information that would help potential users determine whether or not the project is appropriate or adequate for their site or specific use case.

This would be similar to the README templates.
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... โ†’

Proposed resolution

Here, write an introduction that summarizes the purpose and function of this project with a focus on users brand new to Drupal. Answer the question: What solution does this module provide? The first 200 characters of this will be shown in the Project Browser. Alternatively, you can manually hit "edit summary" above and manually enter the exact summary you want (it should be 200 characters or less).

<h3 id="module-project--features">Features</h3>
Here, answer the following questions: What is the basic functionality? What unique features does enabling this project add? When and why would someone use this module? What use cases are there?

<h3 id="module-project--post-installation">Post-Installation</h3>
How does this module actually work once I install it? Should I go to a config page? Should I look for a new content type? Should I go and manage my input formats? Provide an overview of the configuration process and any other special considerations for the module.

<h3 id="module-project--additional-requirements">Additional Requirements</h3>
Does this project need anything beyond Drupal core? Include any dependent modules, libraries, APIs, etc., that are required for this project to work.

<h3 id="module-project--recommended-libraries">Recommended modules/libraries</h3>
Are there any projects that enhance or improve the functionality of this project?

<h3 id="module-project--similar-projects">Similar projects</h3>
If there are modules providing similar functionality, please describe what differentiates them.

<h3 id="module-project--support">Supporting this Module</h3>
If you have a Patreon, OpenCollective, etc. you can put links here to describe how people can support development. 

<h3 id="module-project--community-documentation">Community Documentation</h3>
A great place to add links to YouTube walkthroughs, external documentation, or a demo site (use DrupalPod!).

You may continue to put additional information below here, if there are other things you think people need to know about your module!
โœจ Feature request
Status

Fixed

Version

3.0

Component

Code

Created by

๐Ÿ‡บ๐Ÿ‡ธUnited States volkswagenchick San Francisco Bay Area

Live updates comments and jobs are added and updated live.
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.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine

    Here, write an introduction that summarizes the purpose and function of this project with a focus on users brand new to Drupal. Answer the question: What solution does this module provide? The first 200 characters of this will be shown in the Project Browser "grid" view. You can also manually hit "edit summary" above and manually enter the exact summary you want.

    Features

    Here, answer the following questions: What is the basic functionality? What unique features does enabling this project add? When and why would someone use this module? What use cases are there?

    Post-Installation

    How does this module actually work once I install it? Should I go to a config page? Should I look for a new content type? Should I go and manage my input formats? Provide an overview of the configuration process and any other special considerations for the module.

    Additional Requirements

    Does this project need anything beyond Drupal core? Include any dependent modules, libraries, APIs, etc., that are required for this project to work.

    Recommended modules/libraries

    Are there any projects that enhance or improve the functionality of this project?

    Similar projects

    If there are modules providing similar functionality, please describe what differentiates them.

    Supporting this Module

    If you have a Patreon, OpenCollective, etc. you can put links here to describe how people can support development.

    Community Documentation

    A great place to add links to YouTube walkthroughs, external documentation, or a demo site (use DrupalPod!).

    You may continue to put additional information below here, if there are other things you think people need to know about your module!

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States chrisfromredfin Portland, Maine

    Moving this over to the Drupal.org customizations queue as it's seen some review & additions and I think we can do this!

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States drumm NY, US

    One small nit - โ€œโ€ฆ and manage my input formats?โ€ If I recall correctly, these are โ€œtext formatsโ€ in the Drupal admin UI.

    The first 200 characters of this will be shown in the Project Browser.

    We can align this with what is shown for project browsing on Drupal.org itself. That limit is currently 600 characters.

    It looks like Drupal is counting characters, not bytes, so we donโ€™t have to worry about 200 bytes not being a lot for multi-byte characters.

  • First commit to issue fork.
  • @fjgarlin opened merge request.
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡ช๐Ÿ‡ธSpain fjgarlin

    I added the proposed resolution to a branch and created the MR for it.

    You can see it when creating brand new projects: https://fjgarlin-drupal.dev.devdrupal.org/node/add/project-module

    • drumm โ†’ committed ee43696c on 7.x-3.x
      Issue #3230734 by fjgarlin, chrisfromredfin, volkswagenchick,...
  • Status changed to Fixed over 1 year ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States drumm NY, US

    This is now set on production. Thanks all!

  • ๐Ÿ‡ช๐Ÿ‡ธSpain fjgarlin

    Good call. I jumped straight into code forgetting about the default value via UI.

  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024