-
Notifications
You must be signed in to change notification settings - Fork 19
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
Enhance ontology / oeo page #1496
Comments
- Improve page layout - Fix broken module and import descriptions - Add Download and OEO view access buttons to the sidebar and improve UX #1496
I had some time last week to improve the ontology pages in the OEP. If we have time, we will install this update on the TOEP today and you can test it there. Finally, all modules and imports also reflect the descriptions that are available in the oeo files. I have also regrouped the buttons to make them easier to understand The page now looks like this: |
@jh-RLI thanks for updating the page. It looks much better now.
|
I think it would be good to create a new issue, as we reference these issues in the commits / pull requests and I don't want to bloat individual issues more than necessary. But this is just a side node, I like the idea of revising it further as all I was doing was the absolute bear minimum as things weren't working properly, like the description in modules and so on. I also have one more PR ready that will improve the loading time of the page a bit and visually marks editor notes apart from definition / description text. #1502
Thats true i overlooked the buttons and only removed the other module once.
Good hint reagrding the OBO principles. I will add the version first.
Almost all of the text you see comes from the oeo release files. But of course we can also add text that was created specifically for this page. I think the idea was that we can theoretically list multiple ontologies and the pages will be populated from the ontology files. At least that's what the implementation suggests to me. Not sure if we still plan to do something like this.
We could do this, currently we only store the latest version on the oep server. |
My suggestion is to merge the "Overview" page and the "Modules" page:
|
This is also related but maybe outdated #1142 |
We are being approached by users because of this page, see OpenEnergyPlatform/ontology#1847 I think it is partially related to this issue. If it is not a time consuming issue, I'd be happy to fix this rather soon. We could also do it in a (bilateral) session together. |
Description of the issue
The ontology/oeos page is not well structured and not user friendly as the buttons to download the publication files and other buttons to browse the oeos are grouped together. It is not explained where and how users can use and find these functions.
Ideas of solution
Introduce section that guide the user better:
Group the available buttons and add better icons/styles.
Figure out what content should be displayed and what not
Workflow checklist
The text was updated successfully, but these errors were encountered: