Skip to content

Commit

Permalink
Add documentation for admin page
Browse files Browse the repository at this point in the history
  • Loading branch information
FuHsinyu authored and stsnel committed Oct 11, 2024
1 parent 51f38f6 commit 75e27a7
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 0 deletions.
Binary file added docs/administration/img/yoda-admin-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/administration/img/yoda-admin-terms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/administration/img/yoda-admin-theme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/administration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Specific information:
- [Installing preservable file formats](installing-preservable-file-formats.md)
- [Installing metadata schemas](installing-metadata-schemas.md)
- [Installing datarequest module](installing-datarequest-module.md)
- [Setting portal themes via Admin GUI](setting-theme.md)
- Rulesets changes:
- [Applying a temporary local change to a ruleset](hotfixing-ruleset.md)
- [Applying a permanent local change to a ruleset](local-ruleset-patch.md)
Expand All @@ -31,6 +32,8 @@ Specific information:

- [Graciously stopping revision and replication jobs](setting-job-flags.md)
- [Using Python-irodsclient](using-python-irodsclient.md)
- [Setting a maintenance banner via Admin GUI](setting-maintenance-banner.md)


## Troubleshooting

Expand Down
7 changes: 7 additions & 0 deletions docs/administration/installing-terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,11 @@ To add a new terms file just put it in the `/${RODSZONE}/yoda/terms` collection
iput "${TERMS}.txt" "/${RODSZONE}/yoda/terms/${TERMS}.html"
```

From version 1.10, Yoda simplifies managing publication terms with a new GUI on the Admin page. Just enter and save terms directly in the GUI; they're instantly updated and stored as an HTML page at `/var/www/yoda/config/publication_terms.html`. The system now checks this folder first before looking at the iRODS server for any terms. See the picture below for an example.

<div style="text-align: center;">
<img src="./img/yoda-admin-terms.png" alt="Example of Installing Terms with GUI" style="width: 50%; height: auto;">
<p style="color: gray;"> Example of Installing Terms with GUI</p>
</div>

All vault packages with an action log record "submitted for publication" from before the create time of the new terms file were accepted under the old terms.
13 changes: 13 additions & 0 deletions docs/administration/setting-maintenance-banner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
parent: Administration Tasks
title: Setting a maintenance banner via Admin GUI
nav_order: 19
---
# Setting a maintenance banner via Admin GUI
From version 1.10, administrators can easily set or remove the maintenance banner using the Admin GUI. Configuration settings for the banner are stored in `/var/www/yoda/config/admin_settings.json`. Below is an example of a typical maintenance banner.

<div style="text-align: center;">
<img src="./img/yoda-admin-banner.png" alt="Example of Setting a Maintenance Banners via Admin GUI" style="width: 50%; height: auto;">
<p style="color: gray;"> Example of Setting a Maintenance Banners with GUI</p>

</div>
29 changes: 29 additions & 0 deletions docs/administration/setting-theme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
parent: Administration Tasks
title: Setting portal themes via Admin GUI
nav_order: 20
---
# Setting portal themes via Admin GUI
From version 1.10, Yoda simplifies setting portal themes with a new GUI on the Admin page. Once the templates are installed in the `yoda/themes/`, just select the theme directly in the dropdown list; the theme is instantly updated. See the example below for changing the theme to VU.

<div style="text-align: center;">
<img src="./img/yoda-admin-theme.png" alt="Example of Setting Themes with GUI" style="width: 50%; height: auto;">
<p style="color: gray;">Example of Setting Themes with GUI</p>
</div>

Below is a list of the pre-installed theme options available. Each theme is presented in the format of template folder : displayed name.

uu: Utrecht University - Default
uu_its: Utrecht University - ITS
uu_gw: Utrecht University - Humanities
uu_youth: Utrecht University - YOUth
uu_i-lab: Utrecht University - i-lab
uu_science: Utrecht University - Science
uu_fsw: Utrecht University - Social Science
uu_geo: Utrecht University - Geo
uu_dgk: Utrecht University - Veterinary Medicine
uu_dag: Utrecht University - Data Archive for Geoscience (DAG)
vu: Vrije University Amsterdam
wur: Wageningen University & Research

To install a new theme to be selected, users need to prepare the theme package following the instructions provided in the [Theme Packages](../design/overview/theme-packages.md) documentation.
3 changes: 3 additions & 0 deletions docs/design/overview/theme-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,9 @@ To create another select2 theme first copy the select2-theme-uu.scss file, and t
```
The theming is based on this [select2 bootstrap 5 theme](https://github.com/g10f/select2-bootstrap-5-theme) fork.

## Theme change via Admin GUI
From version 1.10 onward, Yoda supports changing themes through the admin GUI; to make themes available, add their packages (including templates and static files) to `/var/www/yoda/themes`, where the admin page recognizes available themes by reading the folder names—as Flask scans this directory for themes. Once you select a new theme via the admin page, it updates the theme configuration in `/var/www/yoda/config/admin_settings.json` under the YODA_THEME key (e.g., "YODA_THEME": "uu").

## DavRODS theming

DavRODS uses different theming logic than the portal. By default, it uses the themed logo of the portal.
Expand Down

0 comments on commit 75e27a7

Please sign in to comment.