Skip to content

Port [and minimally update] aiida-registry browser into the website#165

Merged
khsrali merged 2 commits into
mainfrom
registery-rework
May 13, 2026
Merged

Port [and minimally update] aiida-registry browser into the website#165
khsrali merged 2 commits into
mainfrom
registery-rework

Conversation

@khsrali
Copy link
Copy Markdown
Contributor

@khsrali khsrali commented May 8, 2026

Brings the plugin browser at aiidateam.github.io/aiida-registry into this site as /plugin-registry/, statically rendered (one HTML per plugin) with client-side fuzzy search and sort. Data is pulled at build time from the canonical registry's plugins_metadata.json, never committed; existing verdi-cli.json and pypi-stats.json are migrated to the same fail-fast policy with schema-only *.example.json siblings for documentation. The upstream aiidateam/aiida-registry repo remains the source of truth for plugins.yaml and the daily metadata generator — this PR only ports the presentation layer.

Re-opened from an upstream branch (was #164) so Cloudflare Pages can render a preview.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 8, 2026

Deploying aiida-website with  Cloudflare Pages  Cloudflare Pages

Latest commit: dce0ede
Status: ✅  Deploy successful!
Preview URL: https://0d563d12.aiida-website.pages.dev
Branch Preview URL: https://registery-rework.aiida-website.pages.dev

View logs

Comment thread src/pages/plugin-registry/index.astro Outdated
Comment on lines +21 to +25
{totalPackages} community plugins extending AiiDA — simulation codes, data types,
schedulers, transports, and workflows. To add yours, open a PR against{' '}
<a href="https://github.com/aiidateam/aiida-registry" target="_blank" rel="noopener noreferrer">
aiidateam/aiida-registry
</a>.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • totalPackages resolves to 106, but current website shows 108
  • The subtitle is a bit redundant, mostly covered by the summary below. Maybe instead we invent some catchy slogan or something (TBD)?
  • "To add yours, open a PR against ..." - too technical. How about "Register your plugin here", with "here" linking to the repo?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The subtitle is a bit redundant, mostly covered by the summary below. Maybe instead we invent some catchy slogan or something (TBD)?

What's your suggestion, I'm open to suggestions.

"To add yours, open a PR against ..." - too technical. How about "Register your plugin here",

ok

totalPackages resolves to 106, but current website shows 108

this we discussed yesterday.

Comment thread src/styles/registry.css
Comment thread src/components/PluginRegistryList.tsx Outdated
<h2 className="reg-card-name">{key}</h2>
{p.is_installable === 'True' && (
<span className="reg-installable" title="Installs successfully against the latest aiida-core docker image">
<CheckIcon /> installs
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the CheckIcon is enough, since the hover tip clarifies? If you think the text is needed, we need to rethink. "installs" sounds weird to me.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the plugin-specific page, you have under registry checks "All checks passed.". This could be an alternative, but I still think maybe the checkmark is nicer (simpler) for the landing page.

On that note though, let's remove the period from "All checks passed."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd keep the text, otherwise not super clear what does that check mark means.
installs - > installable?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Installs successfully" if you must keep the text. In the absence of text, if unclear, my first instinct would be to hover over it, hence I would propose to make it a hover text 🙂

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check it out now, it's a combination of both

Copy link
Copy Markdown
Member

@edan-bainglass edan-bainglass May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, now that I can see it, I strongly recommend that we move "installs successfully" to a hover tip.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's ok man. otherwise just a checkbox might be perceived as "all-good" which is dishonest. Notr: not everyone hoovers, and on phone there is no hoovering you gotta click.

Comment on lines +291 to +295
<p className="reg-results-count">
{query.trim()
? `${visibleEntries.length} match${visibleEntries.length === 1 ? '' : 'es'} for "${query.trim()}"`
: `${visibleEntries.length} plugins`}
</p>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already covered in the summary. Remove.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

it's useful in case searching / filtering

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm 🤔 Okay, keep for now.

Comment thread src/pages/plugin-registry/[key].astro Outdated
Copy link
Copy Markdown
Member

@edan-bainglass edan-bainglass left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @khsrali. This is fantastic! Please see my comments (minor changes).

Also, great if you can add a back-to-top button at bottom right that shows up once you scroll down a bit (and disappears when you're back to the top. A common feature for lenthy pages such as this 🙏

Other than that, LGTM! So happy to see this merged into the main site.
Will approve once changes are in!

@khsrali
Copy link
Copy Markdown
Contributor Author

khsrali commented May 8, 2026

thanks a lot @edan-bainglass for your review! will adopt, later and ping you again
For the moment what's your opinion on colors:
image

I feel like it's too colorful, we could alternatively get rid of the colors and have classic transparent buttons.

@edan-bainglass
Copy link
Copy Markdown
Member

thanks a lot @edan-bainglass for your review! will adopt, later and ping you again For the moment what's your opinion on colors: image

I feel like it's too colorful, we could alternatively get rid of the colors and have classic transparent buttons.

Colors are good. Keep it. What IS jarring is the white background of the text next to them, e.g. "stable" next to "status". Maybe make it light gray?

Also, I never liked "Other (blah blah blah)" - it's too long and causes this annoying folding. Let's just do "Other" and move the "blah blah blah" to a hover tip.

@khsrali
Copy link
Copy Markdown
Contributor Author

khsrali commented May 8, 2026

Also, I never liked "Other (blah blah blah)" - it's too long and causes this annoying folding. Let's just do "Other" and move the "blah blah blah" to a hover tip.

Yes! that bothers me too 👍🏽

Maybe make it light gray

👍🏽

@khsrali
Copy link
Copy Markdown
Contributor Author

khsrali commented May 8, 2026

Note for me:
TODO: check the mobile view

@khsrali
Copy link
Copy Markdown
Contributor Author

khsrali commented May 12, 2026

@edan-bainglass , I've adopted the review
Please have another look, once you have a minute
Cheers

@khsrali khsrali requested a review from edan-bainglass May 12, 2026 09:22
@khsrali khsrali force-pushed the registery-rework branch from f3fb281 to afa18f3 Compare May 12, 2026 09:22
@edan-bainglass
Copy link
Copy Markdown
Member

@edan-bainglass , I've adopted the review Please have another look, once you have a minute Cheers

Broken review links?

@khsrali
Copy link
Copy Markdown
Contributor Author

khsrali commented May 12, 2026

@edan-bainglass
Copy link
Copy Markdown
Member

Broken review links?

@edan-bainglass works for me: https://registery-rework.aiida-website.pages.dev/plugin-registry/

Blocked by PSI 🥲 Checking on phone

@edan-bainglass
Copy link
Copy Markdown
Member

Thanks @khsrali. Looks great overall. A few comments:

  • You changed the color scheme. Let's please keep it as it was before. You can propose a new color scheme in a separate PR 🙏
  • I couldn't test the hover tip on the OTHER category, but I take it this was implemented?
  • Regarding "106 plugins" all over the place, see my comments above
  • Test also on small screens. For example, the summary overflows in a not-so-friendly way.

Comment thread src/pages/plugin-registry/index.astro Outdated
Comment on lines +21 to +22
{totalPackages} community plugins extending AiiDA — simulation codes, data types,
schedulers, transports, and workflows. Register your plugin{' '}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{totalPackages} community plugins extending AiiDA — simulation codes, data types,
schedulers, transports, and workflows. Register your plugin{' '}
Community plugins extending AiiDA with simulations, workflows, data types, and more. You can register new plugins{' '}

Copy link
Copy Markdown
Member

@edan-bainglass edan-bainglass May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For sure drop total packages count. We state it in way too many places. The rest of my edits are mostly to remove schedulers/transports, as these may be less common terminology. Feel free to keep the last sentence as is if you prefer it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also feel free to keep the long dash instead of "with"

Copy link
Copy Markdown
Member

@edan-bainglass edan-bainglass left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few more comments 🙂

@khsrali
Copy link
Copy Markdown
Contributor Author

khsrali commented May 12, 2026

I couldn't test the hover tip on the OTHER category, but I take it this was implemented?

image

You changed the color scheme. Let's please keep it as it was before. You can propose a new color scheme in a separate PR 🙏

No the colors was really unusable and confusing, colors where used randomly for workflow/data/calcjob etc, and the same colors for alarms: stable(green) planned (red), etc.
It's more united and more sensical. I don't see why this has to go to a separate PR

@khsrali
Copy link
Copy Markdown
Contributor Author

khsrali commented May 12, 2026

NOTE FOR ME:
TODO:
Regarding "106 plugins" all over the place, see my comments above
Test also on small screens. For example, the summary overflows in a not-so-friendly way.

Comment thread src/pages/plugin-registry/index.astro Outdated
@edan-bainglass
Copy link
Copy Markdown
Member

No the colors was really unusable and confusing, colors where used randomly for workflow/data/calcjob etc, and the same colors for alarms: stable(green) planned (red), etc. It's more united and more sensical. I don't see why this has to go to a separate PR

Because the PR is titled "Port ...", not "Port and update..." 🙂 I'm mostly fine with the new colors (some blues might be too close in tone), but such frontend changes should in general go through the team (or at least more than one person).

@khsrali
Copy link
Copy Markdown
Contributor Author

khsrali commented May 12, 2026

Because the PR is titled "Port ...", not "Port and update..." 🙂 I'm mostly fine with the new colors (some blues might be too close in tone), but such frontend changes should in general go through the team (or at least more than one person).

well, tbh, a lot of your review comments were more of updates than ports 😆 (don't get me wrong, I love your suggestions and it's totally fine.)

@khsrali khsrali changed the title Port aiida-registry browser into the website Port [and minimally update] aiida-registry browser into the website May 12, 2026
@edan-bainglass
Copy link
Copy Markdown
Member

edan-bainglass commented May 13, 2026

well, tbh, a lot of your review comments were more of updates than ports 😆 (don't get me wrong, I love your suggestions and it's totally fine.)

Were they? 😅 Anyhow, I still wouldn't change the colors in this PR. But you do you 💪

@khsrali khsrali force-pushed the registery-rework branch 2 times, most recently from 44a14a9 to 26dbf22 Compare May 13, 2026 10:18
Co-authored-by: Edan Bainglass <45081142+edan-bainglass@users.noreply.github.com>
@khsrali khsrali force-pushed the registery-rework branch from 26dbf22 to dce0ede Compare May 13, 2026 10:21
@khsrali khsrali requested a review from edan-bainglass May 13, 2026 10:21
Copy link
Copy Markdown
Member

@edan-bainglass edan-bainglass left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @khsrali. LGTM!

@khsrali khsrali merged commit 2019f88 into main May 13, 2026
3 checks passed
@khsrali khsrali deleted the registery-rework branch May 13, 2026 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants