On this page
Module Maintainers: How to update projects to be compatible with Project Browser
The Project Browser Initiative is working on a new Browse page for the Extend functionality (modules). The default display of the Project Browser will include compatible Drupal projects, ordered by popularity. A card will be displayed for each of the modules (projects). Three key components displayed on the card will include a logo, a short description, and the top (up to 3) categories to which this module belongs.
For your project/module to appear in Project Browser, the aforementioned key components need to be available on your drupal.org project page.
Logo
- Design a logo for the module.
- Create a logo that is 512x512 square dimension in PNG format without animations. Suggested file size should be 10k or less. (Please note: you should not round the corners in the PNG itself or include the name of the module in the logo, unless there is some compelling branding reason.)
- Use a lossy image tool (such as pngquant) to reduce file size while keeping the image quality at around 80%.
- Place the logo in the root directory of the Git repository for your project, on the default branch. The logo file should be named
logo.png. The logo will be displayed in the Project Browser, as well as on drupalcode.org as your project avatar, and on drupal.org on your project page. Logos are cached and may take up to an hour to show. - If you previously added a logo as the first image on the Drupal.org project page, please remove it. Project Browser will no longer be using the first image as the logo.
-
For logos created in a vector format please also provide the logo in svg format (logo_svg.txt) to facilitate changes to the logo in the future.
Short description
- Write a short description that answers the question (in a non-technical way): "What does this module do?" or "Why would I install this?"
- The description should be up to 200 characters. Do not start the description with "The xx module ..." as the module name will display above the short desciption.
- Use the "Edit Summary" option in the module's description field.

- Add your description in the summary area that just appeared. This summary will be used by project_browser.

Categories
- Pick up to three (3) categories that the project should be listed in. For some guidance on category selection, you can refer to the Category Descriptions. (Note - the original list of 55 categories had been reduced to 19)

Other Areas
Maintenance Status: Make sure to set your maintenance status to accurate reflect the state of your module. Is it actively maintained? Seeking co-maintainer? Make sure to set it accurately. This can be used as a filter in the Project Browser.
Development Status: The same goes for development status. This can be used as a filter in Project Browser, so make sure it's accurate.
Long Description: It might also be a good time to re-visit the full description of your module and what it does. In fact, we have suggested a template that you can see when creating a new project - you may wish to use this for guidance on your long description.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion