https://github.com/juke34/rado_members
RADO (Réseau d’Analyse de DOnnées) interactive member info page https://Juke34.github.io/RADO_members/
https://github.com/juke34/rado_members
Last synced: over 1 year ago
JSON representation
RADO (Réseau d’Analyse de DOnnées) interactive member info page https://Juke34.github.io/RADO_members/
- Host: GitHub
- URL: https://github.com/juke34/rado_members
- Owner: Juke34
- License: lgpl-3.0
- Created: 2024-12-10T10:17:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-07T10:22:54.000Z (over 1 year ago)
- Last Synced: 2025-01-07T11:34:09.189Z (over 1 year ago)
- Language: CSS
- Homepage:
- Size: 7.01 MB
- Stars: 1
- Watchers: 1
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RADO interactive member info page [](https://github.com/Juke34/RADO_members/actions?workflow=build)
https://Juke34.github.io/RADO_members/
---------------------------
## Table of Contents
* [Description of this repo](#description-of-this-repo)
* [How to create a new entry](#how-to-create-a-new-entry)
* [How does it work](#how-does-it-work)
* [GDPR](#gdpr)
* [Help](#help)
* [Acknowledgement](#acknowledgement)
## Description of this repo
This repository contains data used to generate the interactive page.
```
staff-info/
|___ assests # folder containing logo and style sheet for page rendering
|___ trombinoscope # folder containing information related to individuals
| |__ photo # folder with photo of individuals. Must be firstname-lastname.jpg
| |__ staff # folder with description of the individuals. Must be firstname-lastname.yaml
|___ index.Rmd # Markdown file executed by github actions to generate the the interactive page.
```
## How to create a new entry
Entries are located in the `trombinoscope` folder.
### Your information in a .yaml file
In order to add yourself to the staff pages create a file
`firstname-lastname.yaml` in the `trombinoscope/staff` and add your information.
Use the `trombinoscope/staff/TEMPLATE.yaml` file as a starting point and look at the existing YAML
files to see how you may fill it out.
* Note that you can use markdown syntax for the `bio:` entry, e.g. for links.
The YAML format is described at [yaml.org](https://yaml.org/). You can
check that a YAML file is valid by pasting the content at
[yamllint.com](http://www.yamllint.com/).
* Keep in mind that `:` is a reserved character, so if you for some
reason have a `:` character in e.g. your bio, please replace it with the
escape code `:`.
* Multi-line strings should be indented.
* Create paragraph breaks in bio by inserting two blank lines.
### Photo in a .jpg file
Add a photo of yourself in the `trombinoscope/photo` subdirectory, and make sure that
the file name matches the entry `image:` in your YAML file. Consider
adjusting the image so that it is no more than about 400 pixels wide and
less than 200 KB in file size.
### Publish
You can either clone the repository and create a new branch and commit
your changes there, then push your changes, or simply use the Github web
interface to create/upload a new file. Create a new
branch there and commit all your changes. You can then create a pull
request to ask a webadmin to review and merge your changes.
## How does it work
The master branch contains the GitHub action script that runs all the tasks and the Rmarkdown document that ends up as the rendered HTML page. The rendered material is made available publicly on the gh-pages branch.
The material used as input is the YAML files avaiable in `trombinoscope/staff`. Each YAML file is parsed
and, provided the setting `active:` is set to `true`, the
corresponding staff member is added to the staff listing, and a staff page is generated.
This web page is rebuilt automatically when any changes to the master repo is made.
**Build**
The linux environment, dependencies, R and necessary R packages are installed or recovered from cache. Repo master branch is pulled down, images are processed using Imagemagick into 100px x 100px circular PNGs. The Rmarkdown script reads information from the YAML files and finally displays a tabular interactive page. The rendered HTML page, it's dependencies, assets and processed images are pushed to NBISweden/staff-finder gh-pages branch.
## GDPR
The staff YAML files contain personal data (e.g. first name).
The data you share are used to set the staff list website. The data are used only for that purpose.
You can modify or remove any information via a PR or by contacting the owner or any contributor of this repository.
You must ask permission to any person you modify or add information.
You must verify identity of any person asking you to perform a modification.
More about GDPR [here](https://gdpr-info.eu).
## Help
Please ask for help by [opening an issue in this
repository](https://github.com/southgreenplatform/staff-info/issues)
(this is the preferred way), or ask in the SouthGreen Slack, or [email](https://www.southgreen.fr/contact) if anything is unclear or broken.
## Acknowledgement
This work is based on [staff-finder](https://github.com/NBISweden/staff-finder) developed by [NBIS](https://nbis.se).