Problem/Motivation

Logo for Autoban project does not show by Project browser module and on the Project modules page

Proposed resolution

I used the logo from https://www.drupal.org/project/advban/issues/3459437
Can you check, please, why the logo doesn't show

Comments

goodboy created an issue. See original summary.

heikkiy’s picture

I think the problem might be because looking at https://git.drupalcode.org/project/autoban/-/tree/7.x-1.x?ref_type=heads the default branch is 7.x-1.x and the logo.png is not present there. The logo can be found from https://git.drupalcode.org/project/autoban/-/tree/8.x-1.x?ref_type=heads.

I was able to get it showing in another project by switching the default branch in Gitlab to be the one with the logo.png. This was mentioned in #3474473: Update logo for compatibility with Project Browser.

Note also that Project browser seems to cache the logo images and #3469860: Allow clearing of Key-Value store data for Project Browser sources seems to be a related issue to that.

goodboy’s picture

@heikkiy, thank you very much for your answer. I have changed the default branch to 8.x-1.x and I can see the logo at the https://git.drupalcode.org/project/autoban . Hopefully I will have to wait a bit for the project images to update.

leslieg’s picture

Status: Active » Needs work
StatusFileSize
new611.36 KB

This documentation should help: Module Maintainers: How to update projects to be compatible with Project Browser

Check the requirements and ensure the logo.png is on your default branch. It is not displaying on the drupal.org project page to the left of the project name. (could be the Cache issue mentioned above) Also, please remove the logo from the first image on your drupal.org project page as that is no longer the recommendation.

See attached file "Screenshot 2025-01-27 at 2.56.04 PM.png"

Note - also check the Short Description and Category requirements to help make your module easier to find and understand in the Project Browser.

chrisfromredfin’s picture

StatusFileSize
new87.32 KB

The other thing to note is that if you ask for it, then update, Project Browser tends to aggressively "cache" data that we've requested from the endpoint. This is not in regular cache, but in key-value storage (for... reasons). So PB has a UI where you can flush that data. Then you might start seeing the data in PB as long as you're seeing it on your project page.

Config > Development > Project Browser > Actions.

clear storage button

goodboy’s picture

@leslieg, thank you. I have removed the first picture from the module's page (https://www.drupal.org/project/autoban)

goodboy’s picture

@leslieg, thank you again. I can see logo for my projects. But I am shocked that the description is wrong. How do you write descriptions for modules?
@chrisfromredfin, I tried to click to the button but the storage didn't clear. I see very old and wrong description to my modules. What I need to do to fix the great problem for me?

Can I have description for my modules from https://www.drupal.org/project/project_module?f%5B44%5D=&f%5B46%5D=&f%5B... ?
If your module can't get correct module descriptions, is there a way to opt out of being included in the "index" of your module?

leslieg’s picture

Hi @goodboy. The Short description on the cards pulls from the Summary field on your Drupal.org project page. If the Summary field is empty, the first 200 characters of the Description field are displayed. followed by ellipses.

That's why Autoban displays a short description of "🇺🇦 This module is maintained by Ukrainian developers. Please consider supporting Ukraine in a fight for their freedom and safety of Europe. Advanced ban is a replacement to Drupal core Ban module…"

Enter text in the Summary field (off of the Description field - note it may be hidden) and you should be all set.
Note - The short description should answer this question (in a non-technical way): "What does this module do?" or "Why would I install this?"
The short description can be be up to 200 characters. Do not start the description with "The xx module ..." as the module name will display above the short desciption.

You should also check the categories assigned. We recommend one category, however you can have up to three if you feel your module should fall under additional categories, For guidance on category selection, please read Category Descriptions.

A reference that will be helpful Module Maintainers: How to update projects to be compatible with Project Browser

chrisfromredfin’s picture

@goodboy, AHA! OK, so what you're actually seeing then is a delay in when we update the information in Project Browser. Actually, our endpoint is running off a D10 version of Drupal.org where we migrate the data from the existing drupal.org to that one on a nightly schedule.

It may take a while for the canonical data to move from drupal.org over to the new site.

I'll ask @fjgarlin how long we should expect data to update, or if we're using `--update` with our migration.

fjgarlin’s picture

We are not running migrations with --update. I’d expect that Drupal migrations catch the update at the source and propagate nodes that have been updated. But maybe this is not happening.

Migrations run once per hour, but just drush migrate:import drupalorg_migrate_project_module
The migration for projects is this one.

Due to our setup, we cannot use high water marks, but maybe we can use track_changes or run with --update once a day only. I just triggered a migration with --update manually in any case right now.

fjgarlin’s picture

After triggering the update and reindex, the data seems to be ok: https://www.drupal.org/jsonapi/index/project_modules?filter[machine_name...

I created #3505722: Track changes on migrations or update more regularly so we can take care of these things in the endpoint.

goodboy’s picture

Status: Needs work » Fixed

Thank you all, now description of my projects are correct

leslieg’s picture

leslieg’s picture

assigned credit

Status: Fixed » Closed (fixed)

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