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

Admin UI #322

Open
GeoffreyKarnbach opened this issue Oct 1, 2024 · 1 comment
Open

Admin UI #322

GeoffreyKarnbach opened this issue Oct 1, 2024 · 1 comment
Labels
major major feature for this milestone Master/Epic Container for multiple sub issues new feature New feature or request

Comments

@GeoffreyKarnbach
Copy link
Contributor

GeoffreyKarnbach commented Oct 1, 2024

Description
A list of all possible features:

  • Internal Storage Management
  • Banner Management
  • User Management
  • DMP List
  • Recommended repositories
  • Statistics

Internal Storage Management

Manage internal storages and their translations from a page inside of the Admin Panel.

Related features:
tuwien-csd/damap-backend#95
tuwien-csd/damap-backend#198
#236

Banner Management

An admin should be able to enable a banner to be displayed at the top of the DAMAP User Interface (similar to the way a banner is displayed in the dev version)

image

The content of the banner should be customizable:

  • Background color
  • Title
  • Content
  • Closable (Bool)?

User Management

An admin should be able to handle user management through this page. This feature is relevant as soon as custom user management is implemented in DAMAP (see related issue).

Related issue:
tuwien-csd/damap-backend#263

DMP List

The DMP list visible to an admin user on the "/plans" page should be moved to the admin panel (the "All DMPs" section).

image

Recommended repositories

Right now, recommended repositories, that are displayed in Step 8 in the Recommended tab can only be customized in the application.yml file. An admin should be able to edit those repositories from within the admin panel, either by using a text input or by using a similar component to the one the user can use to select a repository to persist data in.

image
Current implementation with the recommended repositories in the config file.

image
Usage of recommended repositories.

image
Possible selection component reusage on admin panel to select recommended repositories to be displayed in the recommended tab.

Statistics

An own Statistic section could be added to the admin panel to display statistics including:

  • General numeric data (Number of DMPs, Datasets ...)
  • Visual representation of statistics (Evolution over time of DMP number for instance?)
  • Usage data

General Design

The Admin Panel could have a completly own sidebar, allowing each of the sections to be inside of an own page, similar to the sections right now like "Home" and "DMPs".

image

Further ideas:

  • Add ability to pull and push the templates from the admin panel, an admin would not need to go on the server to get the word documents but could update them on their computer and upload them back.
@GeoffreyKarnbach GeoffreyKarnbach added new feature New feature or request major major feature for this milestone Master/Epic Container for multiple sub issues labels Oct 1, 2024
@GeoffreyKarnbach GeoffreyKarnbach transferred this issue from tuwien-csd/damap-backend Oct 2, 2024
@GeoffreyKarnbach
Copy link
Contributor Author

To elaborate further:

Why are these features important?

  • Even though some of these admin UI features already exist in some form or place (internal storage, dmp list, recommended repos), adding the banner management (new feature, can be useful to convey information to users), user management (integrate the user management issue, see User Management damap-backend#263 or statistics will offer a better experience for an administrator to work with DAMAP (no need to modify any source files, such as config files manually, or manually collect SQL data to provide statistics).

Ad. Internal Storage: completed as of 1 week ago, the frontend needs to be refactored though to potentially be included as a subtab (to discuss, functionality is here).

Ad. Banner management: Giving a concrete estimate about the needed time to implement it is difficult (probably 5-24 hours, M issue). Right now, no banners can be added in a modular way, similar to the banner of the test instance, it would have to be hardcoded. If this feature is deemed useful, the time saving is major (going from 10-30 minutes to a few seconds potentially).

Ad. DMP List: Just requires to be moved from the /plans page to the admin page (ideally inside of a new tab), very fast probably S issue (1-4 hours)

Ad. Recommended repositories: Right now the admin has to go in the "applications.yml" file and set the recommended repositories (if an error occurs the application can potentially not boot anymore, some basic knowledge about YAML should be there for sure). Implementation wise, the effort is probably around 5-24 hours at most (depending how it is implemented, inside of a config file? inside of the DB?)

Ad. Statistics: Getting some basic statistics done would be quite fast if we only want numeric data. For visual results, the issue is probably in the L range (25-80 hours) depending if an exploration phase for the available technologies was already made and the feature just needs to be implemented. The content of the statistics tabs would vary a lot depending on the requirements.

Each feature should be split into an own subissue, working on those issues would yield some (pretty) fast and visible changes.

The main benefit of working on the admin UI is to provide an easy time customizing DAMAP for new institutions (most of the changes that would be made right now in the source code could be made from the Admin UI).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major major feature for this milestone Master/Epic Container for multiple sub issues new feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant