-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add clients page #30
Add clients page #30
Conversation
The clients page showcases the various available clients to query OPTIMADE databases. There are currently 3 different clients: - Swagger/OpenAPI UI (petstore.swagger.io) - MaterialsCloud Tool (materialscloud.org/optimadeclient) - optimade.science To access this new page, a new menu item "Try It!" has been added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
@blokhin is this page okay with you? Since it mentions you by name and points to your website, I want to make sure you're okay with it and/or if the text should be changed slightly. @ml-evs Could I perhaps ask you to test this locally as well, like you did #29? Specifically if the menu does not look weird now with the extra entry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The menu is now a bit wide (wraps onto two lines when given < half the screen width at 1080p), but no big deal. Could potentially remove "Contributors" as a top-level link and put it under the About section and/or move forums to a link under Documentation?
I like the Try It page though (modulo minor fixes below), perhaps the menu button could be a brighter colour (OPTIMADE blue/red?) for emphasis? I guess a redesign is probably on the horizon anyway...
Please, could you delete the optimade.science for now? The current version is malfunctioning, and we are about to roll out the new major update soon (completely rewritten). I will PR it here as soon as it is ready. |
Fix link targets Co-authored-by: Matthew Evans <7916000+ml-evs@users.noreply.github.com>
In accordance with the wish of @blokhin.
I can find pros and cons for keeping/removing them:
I was thinking the exact same thing! To catch the eye, but looking at it I would have to change a lot of the CSS and HTML design it seems. Not worth it for now 😅 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough, will just approve and let others decide.
I've just added b450a5d which highlights the Try It button in blue, feel free to revert before merging.
The blue button looks good to me... |
I've just done this, so we should be good to go! |
@CasperWA could you check that the changes (URLs etc) you made initially are still valid, then merge when you are happy? |
I see the command |
That's fine, it works in the rendered HTML, we don't have to worry about the markdown here |
I've tested all the client links locally, so I'm going to merge this so as not to block #31. |
In the "Swagger" section, the links to the Materials Project and the Materials Cloud lead to "Failed to load API definition." |
For Materials Cloud, I think this is related to the issue that one cannot reach the generated OpenAPI JSON for the implementations. See also Materials-Consortia/optimade-python-tools#520, which I think is the cause of the endpoint not being reachable. Also, this was the reason for not yet merging it. But I guess it's fine. We should probably remove those links until it's fixed though! |
The clients page showcases the various available clients to query OPTIMADE databases.
There are currently 3 different clients:
To access this new page, a new menu item "Try It!" has been added.
I have requested reviews from the "management", providers I have explicitly mentioned, and client creators, and would especially like all entities who are mentioned on the new page to give their consent.