Multidisciplinary AI Research Centre University of Peradeniya
Contact us

For MARC members

Documentation

How to keep the website's profiles, projects, news and publications up to date.

Common tasks

Some changes touch more than one place. Do every step, or a link between the pages will be missing.

  • A new member joins MARC and a project

    1. Profile form: they fill it in once: profile, photo, other emails and names, and the projects they work on.
    2. Or on GitHub: add the profile in marc_people and their email to each project file in marc_projects.
    3. Their papers: check each paper appears on their profile; if not, add the author-list form of their name to otherNames.

  • Someone joins or leaves a project

    1. marc_projects: add or remove their email in the project's projectMembers or supervisors. Their profile does not change.

  • Someone's email address changes

    1. Profile form: enter the new address under Other email addresses. Project files stay as they are.

  • Someone leaves MARC

    1. Profile form: choose Past member and say where they are now (or set status: past on GitHub). Don't delete the profile.
    2. marc_projects: nothing to change: they stay on their projects, marked as a past member.

  • A new paper is published

    1. Publications sheet: add a row in the project's tab, with the DOI and authors' full names. Copy the row to other projects' tabs if it belongs to several.

  • A project is renamed

    1. marc_projects: rename the file (the page address changes).
    2. Publications sheet: rename the project's tab to match.
    3. Website: ask a maintainer to update highlights and projectPublicationTabs.

How content is linked

Profiles, projects and publications are connected by a few linking keys: values that must be written exactly the same in two places. Everything else can be edited freely. Before changing a key, update the other side too, or the link silently disappears.

Linking key Must match What it connects If it changes
email + otherEmails Profile projectMembers / supervisors in project files A person ↔ their projects Move the old address to otherEmails and every project keeps linking. How to change email + otherEmails safely
name + otherNames Profile Authors column of the publications sheet A person ↔ their publications Move the old form to otherNames and every paper stays on the profile. How to change name + otherNames safely
File name Project The project's tab in the publications sheet; highlights in site.ts A project ↔ its publications; the page address Publications drop off and the address changes. Rename the tab too. How to change File name safely
researchArea Project One of the six research area names A project ↔ its research area page Must stay one of the six names, spelled exactly. How to change researchArea safely
DOI / title Publications sheet The same paper in another tab One paper ↔ several projects The paper is listed twice. Copy rows instead of retyping them. How to change DOI / title safely
File name News article Links shared outside the site The article's page address Shared links stop working. Don't rename after publishing. How to change File name safely

What is edited where

Content Edited in Guide
People profiles Profile form, or marc_people repository, profiles/ folder (opens in a new tab) Guide for people profiles
Projects marc_projects repository, projects/ folder (opens in a new tab) Guide for projects
News articles and vacancies News form, or marc_news repository, articles/ folder (opens in a new tab) Guide for news articles and vacancies
Social feed items Website data Google Sheet, News tab Guide for social feed items
Publications MARC Publications Google Sheet, one tab per project Guide for publications
Home photos, research areas, highlights, contact details Website repository (opens in a new tab) Guide for home photos, research areas, highlights, contact details

How changes go live

  1. Edit on GitHub

    Open the file in the repository and click the pencil icon (or Add file for a new one). If you are not a member of the repository, GitHub forks it for you.

  2. Open a pull request

    Commit to a new branch and open a pull request. An automatic check validates the front matter; if it fails, its message says which file and field to fix.

  3. Merge and rebuild

    When a MARC maintainer merges the pull request, the website rebuilds automatically and your change goes live when the rebuild finishes.

Google Sheet changes (publications, social feed) are picked up at the next rebuild, and at the latest by the weekly rebuild every Monday at 00:00 Sri Lanka time. Need edit access to a sheet or repository? Email marc@eng.pdn.ac.lk.