Port [and minimally update] aiida-registry browser into the website#165
Conversation
Deploying aiida-website with
|
| Latest commit: |
dce0ede
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0d563d12.aiida-website.pages.dev |
| Branch Preview URL: | https://registery-rework.aiida-website.pages.dev |
| {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>. |
There was a problem hiding this comment.
totalPackagesresolves 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?
There was a problem hiding this comment.
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.
| <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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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."
There was a problem hiding this comment.
I'd keep the text, otherwise not super clear what does that check mark means.
installs - > installable?
There was a problem hiding this comment.
"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 🙂
There was a problem hiding this comment.
check it out now, it's a combination of both
There was a problem hiding this comment.
Actually, now that I can see it, I strongly recommend that we move "installs successfully" to a hover tip.
There was a problem hiding this comment.
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.
| <p className="reg-results-count"> | ||
| {query.trim() | ||
| ? `${visibleEntries.length} match${visibleEntries.length === 1 ? '' : 'es'} for "${query.trim()}"` | ||
| : `${visibleEntries.length} plugins`} | ||
| </p> |
There was a problem hiding this comment.
Already covered in the summary. Remove.
There was a problem hiding this comment.
Hmm 🤔 Okay, keep for now.
edan-bainglass
left a comment
There was a problem hiding this comment.
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!
|
thanks a lot @edan-bainglass for your review! will adopt, later and ping you again 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. |
Yes! that bothers me too 👍🏽
👍🏽 |
|
Note for me: |
|
@edan-bainglass , I've adopted the review |
Broken review links? |
@edan-bainglass works for me: |
Blocked by PSI 🥲 Checking on phone |
|
Thanks @khsrali. Looks great overall. A few comments:
|
| {totalPackages} community plugins extending AiiDA — simulation codes, data types, | ||
| schedulers, transports, and workflows. Register your plugin{' '} |
There was a problem hiding this comment.
| {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{' '} |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Also feel free to keep the long dash instead of "with"
|
NOTE FOR ME: |
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.) |
Were they? 😅 Anyhow, I still wouldn't change the colors in this PR. But you do you 💪 |
44a14a9 to
26dbf22
Compare
Co-authored-by: Edan Bainglass <45081142+edan-bainglass@users.noreply.github.com>
edan-bainglass
left a comment
There was a problem hiding this comment.
Thanks @khsrali. LGTM!




Brings the plugin browser at
aiidateam.github.io/aiida-registryinto 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'splugins_metadata.json, never committed; existingverdi-cli.jsonandpypi-stats.jsonare migrated to the same fail-fast policy with schema-only*.example.jsonsiblings for documentation. The upstreamaiidateam/aiida-registryrepo remains the source of truth forplugins.yamland 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.