Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
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
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:
- 3230734-improve-project-descriptions changes, plain diff MR !167
Comments
Comment #2
volkswagenchickI created a placeholder doc in Google drive: https://docs.google.com/document/d/1Ujee_QVa6W96Qv-2e2uBQGyktJVv2j12L01M4672Vmo/edit
(it is currently empty)
Comment #3
volkswagenchickAdded link to collab doc to summary
Comment #4
thejimbirch CreditAttribution: thejimbirch at Kanopi Studios commentedFeedback/comments/questions left in Google Doc
Comment #5
guptahemant CreditAttribution: guptahemant as a volunteer and at QED42 for Drupal India Association commentedAdded some comments in the doc
Comment #6
chrisfromredfinComment #7
chrisfromredfinThe 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:
==========
==========
Comment #8
volkswagenchickThanks Chris for this. Looks good.
Comment #9
chrisfromredfinTalking 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
Comment #10
bsnodgrass CreditAttribution: bsnodgrass at net2Community, Inc. commentedI think this looks really good, my comments below:
Comment #11
tim.plunkett- https://www.drupal.org/docs/develop/issues/fields-and-other-parts-of-an-...
Comment #13
chrisfromredfinComment #14
chrisfromredfinComment #15
chrisfromredfinComment #16
chrisfromredfinMoving this over to the Drupal.org customizations queue as it's seen some review & additions and I think we can do this!
Comment #17
drummOne small nit - “… and manage my input formats?” If I recall correctly, these are “text formats” in the Drupal admin UI.
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.
Comment #20
fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commentedI 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
Comment #23
drummThis is now set on production. Thanks all!
Comment #24
fjgarlin CreditAttribution: fjgarlin as a volunteer and at Drupal Association commentedGood call. I jumped straight into code forgetting about the default value via UI.