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!

Issue fork drupalorg-3230734

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

I created a placeholder doc in Google drive: https://docs.google.com/document/d/1Ujee_QVa6W96Qv-2e2uBQGyktJVv2j12L01M4672Vmo/edit
(it is currently empty)

volkswagenchick’s picture

Issue summary: View changes

Added link to collab doc to summary

thejimbirch’s picture

Feedback/comments/questions left in Google Doc

guptahemant’s picture

Added some comments in the doc

chrisfromredfin’s picture

Title: Project Browser Sitebuilder Subcommittee - Project page template » Improve project descriptions by using a template for the body field
Version: 1.x-dev » 1.0.x-dev
chrisfromredfin’s picture

The Google Doc has outlasted its usable life; transcribing the most recent thoughts back to here in the issue. We can work here moving forward.

Here's the proposed template:
==========


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.

<h3>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>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>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>Recommended modules/libraries</h3>
Are there any projects that enhance or improve the functionality of this project?

<h3>Similar projects</h3>
If there are modules providing similar functionality, please describe what differentiates them.

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

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

==========

volkswagenchick’s picture

Thanks Chris for this. Looks good.

chrisfromredfin’s picture

Talking with @gaurav.kapoor about this in Prague - one thing that would be awesome, he says (and I agree) is adding a section for "Community Resources" - just as an optional section where you can link to YouTube, blog posts, tutorials, etc. generated by the community. Why this is good:

1.) agencies would love to know they could be featured by producing quality content
2.) it takes some of the documentation burden off the maintainer
3.) but maintainer can still review & decide what to include
4.) shows the gaps in documentation for people to produce / provide new quality content

bsnodgrass’s picture

I think this looks really good, my comments below:

  • For our needs with the project browser, I think we should give guidance about the summary being simple and written for a non-technical reader. Plus 1 for #9.
  • Depending on the implementation of modified categories we may need to add notation to this.
tim.plunkett’s picture

Category: Plan » Feature request

chrisfromredfin’s picture

Issue summary: View changes
Issue tags: -Needs issue summary update

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.

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!

chrisfromredfin’s picture

Issue summary: View changes
chrisfromredfin’s picture

chrisfromredfin’s picture

Title: Improve project descriptions by using a template for the body field » Improve project descriptions by using a template suggestion for the body field
Project: Project Browser » Drupal.org customizations
Version: 1.0.x-dev » 7.x-3.x-dev
Component: Documentation » Code

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

drumm’s picture

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.

fjgarlin made their first commit to this issue’s fork.

fjgarlin’s picture

Status: Active » Needs review

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,...

drumm’s picture

Status: Needs review » Fixed

This is now set on production. Thanks all!

fjgarlin’s picture

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

Status: Fixed » Closed (fixed)

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