Skip to content
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

ChRIS Store: Update plugin details page design to account for README display, parameters, and version listing #81

Closed
mairin opened this issue Jul 29, 2020 · 13 comments
Assignees

Comments

@mairin
Copy link
Contributor

mairin commented Jul 29, 2020

(@mairin)

@mairin mairin changed the title ChRIS Store: Update plugin details page to account for README display, parameters, and version listing ChRIS Store: Update plugin details page design to account for README display, parameters, and version listing Jul 29, 2020
@mairin mairin self-assigned this Jul 30, 2020
@mairin
Copy link
Contributor Author

mairin commented Aug 3, 2020

Here is what the plugin details screen looks like when you first come to it.

The orange/yellow labels show where the data comes form from the API. Items in orange are in the plugin-meta object, items in yellow are in the plugin object and need to be made available for the plugin-meta as well.

There are three main tabs on this screen:

  • Overview: Displays a nicely-rendered copy of the README.rst or README.md files from the plugin's repo. It displays the README for the latest version of the repo. Contributor list "view all" ideally would expand inline and allow for collapsing back down.
  • Parameters: Displays a nicely-rendered copy of the plugin parameter list available via the ChRIS Store API. Parameter lists are versioned, so there is a version dropdown to switch versions in case you need access to an older version of the parameter lists. It is not expected that there will be many changes between versions. Ideally would be lazy load but a "View more" link is at bottom for explicit expand.
  • Versions: Displays the list of available versions of the plugin. Will be the same as the list in the parameter version dropdown. Mockup WIP.

Overview tab visible

plugin-details_readme 1

Parameters tab visible

plugin-details_parameters 3

Versions tab to be uploaded in another comment when complete.

@jbernal0019
Copy link
Member

@mairin These look great!

@junaruga
Copy link
Member

junaruga commented Aug 4, 2020

I like it.

Overview page

I like the following parts. It's user friendly.

  • Left side of the page: similar with the man page.
  • Right side of the page: similar with Github repository top page.

@anujsingla
Copy link
Contributor

@mairin look great! Yesterday I have changed Developer nav to Quick Start.
Please change in the design also. Developer -> Quick Start
PR -> #85
cc: jbernal0019

@mairin
Copy link
Contributor Author

mairin commented Oct 14, 2020

Here's the updated version of the plugin details page - the major change here is removing the versions tab, and adding a dropdown to switch versions. One more mockup pending is the list of versions you can get by clicking the link next to the versions dropdown control.

plugin-details_meta-plugin_revision_readme 3

@mairin
Copy link
Contributor Author

mairin commented Oct 15, 2020

List of mockup issues to address:

  • Add new version dropdown to all mockup tabs
  • Add new tab for "Configuration" to display 'min_number_of_workers', 'max_number_of_workers', 'min_cpu_limit', 'max_cpu_limit', 'min_memory_limit', 'max_memory_limit', 'min_gpu_limit', 'max_gpu_limit' which are all overrideable at runtime
  • Remove "v" from version number
  • ChRIS store admins for a given plugin are != as contributors. Contributors is a free-form field, admins are ChRIS store users. Separate contributors out as a separate piece of metadata displayed from admins
  • Mark explicitly what date is meant for the upper right corner and the individual creation dates for the plugin versions.
  • Per plugin version mark version creation date as "release date"
  • Public repo field is editable without JSON upload, make editable for logged in admin users

@mairin
Copy link
Contributor Author

mairin commented Oct 15, 2020

Here's a good set of mockups that addressed all of the above except the public repo field editing - I am thinking just an inline editable form field triggered by a link next to the field on the front page, only visible by a logged in admin? @jbernal0019 I'd love a review of these if you wouldnt mind!

Front Page / README Tab

plugin-details_readme 3

Parameters Tab

plugin-details_parameters 4

Configuration Tab

plugin-details_configuration 1

@jbernal0019
Copy link
Member

Nice @mairin!

Yes, the link to edit public repo should only be visible by a logged in admin.

@jbernal0019
Copy link
Member

@mairin There should also be a way for a logged in admin to add a new admin given the ChRIS store username.

@anujsingla
Copy link
Contributor

@mairin Nice design.

@mairin
Copy link
Contributor Author

mairin commented Oct 21, 2020

@jbernal0019 @anujsingla could we handle the case of a logged in admin adding a new admin (or removing a current admin?) similarly to public repo editing noted above... if you're admin and logged in, you'll see a "add new admin" link at the top of the admin section, and maybe little (X) buttons next to each admin to delete individual admins (with a conf dialog?)

@jbernal0019
Copy link
Member

@mairin Yes, I think a logged in admin should see an "add new admin" link that allows him to add a new admin to the repo. Currently, once a new admin is added to the repo it can not be deleted as that admin might have published new versions of the plugin. One admin can not delete another admin.

@mairin
Copy link
Contributor Author

mairin commented Mar 30, 2021

I had opened #103 to track adding the ability to add a new admin to the repo. Closing this since it's merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants