How To Guide | Get Ahed CMS

Introduction

This is a short guide on how to manage and maintain the CMS (content management system for the Get Ahed Project). All fields in the CMS come with an image on where the fields are seen in the web app.

If you have any questions, please reach out to mat@hexastudios.co

NameLink
Get Ahed Websitehttps://get-ahed.eu
Get Ahed CMShttps://api.get-ahed.eu

Web Pages

This collection defines all the 'non-interactve' web pages in the web app.

To edit an existing web page in the web app, fields are:

  • Title (the headline of the page) REQUIRED
  • Content (the short desciprion of the page)
  • Image (the image for the page)
  • Link
  • Link Label
    • These two labels define the Call to Action in the website header
  • Hero Cards (see definition below) OPTIONAL
    • These appear at the bottom of each page

Notes

  • Name of the Website Page is not editable since this is locked to the web app code.

Hero Cards

These are cards that can appear at the bottom of each web page, they are linked in the Web Pages collection.

  • Title (the headline of the card)
  • Subtitle (the subtitle, underlined of the card)
  • Content (the short desciprion of the card)
  • Image (the image for the card)
  • Color (the colour for the cards background)
  • Link
  • Link Label
    • These two labels define the Call to Action on the card

Dashboard Content

Assessments | Courses

Assessments are called 'Courses' in the CMS. They appear in multiple places in the web app so the below fields may only be partially used on the homepage for example, while other fields are used in the dashboard.

These are the fields:

  • Title
  • Introduction
    • This will be displayed on the intro card on the home page
  • Target Audience
    • This is the underlined audience appearing on the intro card on the home page
  • Content (markdown)
    • This appears on the assessment page (where all modules are displayed)
  • Cover Image
    • This is displayed on the card and used in the hero at the top of the assessment page
  • Colour
    • This is used on the card and is used throughout the dashboard for the buttons
    • It's recommended to use the colour scheme colours
  • Start Course Label
    • This is a string that will be used on the button to start the Assessments
  • Modules (see definition below)
    • You can add a list of modules (from here you can add or edit any modules in the list)
  • Feedback (see definition below)
    • This is the overall feedback for the assesssment
    • Depending on the % of the calculated Assessment grade, this feedback will be displayed on the dashboard

Green Assessments Dimensions | Modules

Green Assessment Dimensions are called 'Modules' in the CMS.

The fields for the Green Assessment Dimensions are:

  • Title
  • Content (markdown)
  • Icon
    • This is used on the card
  • Colour
  • Importance Note
    • This is only displayed on the dashboard
  • Questions (defined below)
    • This is a list of questions for the module
  • Feedback (defined below)
    • This is how the scores are shown on the dashboard (on the charts)

Module Questions

Feedback

Feedback uses the score of the module (or average of a course) and the minimum and maximum percentage fields to determine which feedback is best for the user on the dashboard.

Feedback comes in two types:

  • A Course (Assessment) feedback for the overall feedback per Assessment.
  • A Module (Dimension) feedback for individual feedback per module and it also allows for the recommendation of trainings or courses.

Course Feedback (Assessment Feedback)

  • Title
  • Detail
  • Minimum Percent
  • Maximum Percent

Module Answer Feedback (Dimensions Feedback)

  • Title
  • Detail
  • Minimum Percent
  • Maximum Percent
  • Recommended Training
    • These are linked training courses, the definitions are below, you can add or edt from the module fields.
  • Recommended Case Studies
    • These are linked case studies, definitions are below, you can add or edt from the module fields.

Training Course

‼️ This is a work in progress ‼️

Training courses can be viewed by all users via links, but are recommended to users via the dashboard after completing assessments.

Fields are:

  • Title
  • Introduction
    • This will only appear on the card recommending the case study
  • Duration of Course (in minutes)
  • Content (markdown)
  • SCORM File
    • This is a work in progress
  • Icon - this is displayed on the card only
  • Cover Image - this is displayed at the top of the

Case Studies

Case studies (like Training Courses) can be viewed by all users via links, but are recommended to users via the dashboard after completing assessments. Fields are:

  • Title
  • Introduction
    • This will only appear on the card recommending the case study
  • Date of case study
  • Location
  • Content (markdown)
  • Icon - this is displayed on the card only
  • Cover Image - this is displayed at the top of the

Non Interactive Pages

About Pages

Project Focus

There is only one field, the focus.

Project Objectives

Fields are:

  • Image
  • Objective
  • Description
    • For best results, these should be of similar lengths

Project Partners

Fields are:

  • Name
  • Image
  • Description
    • For best results, these should be of similar lengths
  • Link
    • This link should open to an external web page, but can be used to route internally on the web app using /<page>

News and Events

News

The fields for the news articles:

  • Title REQUIRED
  • Subtitle
  • Content (Markdown)
  • Cover Image
    • Please note a default image is set up, but this will get boring if all images are the same
  • Date Published
    • This can be used to pre-post blog updates and news (they won't be available on the website until the date specified)

Events

  • Title
  • Event Date
  • Cost
  • Link (this is where users will be redirected on click)
  • Cover Image
    • Please note a default image is set up, but this will get boring if all images are the same

Other Initiatives

The fields for the other initiatives articles (very similar to a News Article):

  • Title REQUIRED
  • Subtitle
  • Content (Markdown)
  • Cover Image
    • Please note a default image is set up, but this will get boring if all images are the same
  • External Links
    • These can be reused across multiple initiatives
    • They have a label and a URL

Help And Support

Fields are only title and content. Content is stored as markdown.

  • Title
  • Content