Skip to content

Latest commit

 

History

History
112 lines (59 loc) · 3.7 KB

README.adoc

File metadata and controls

112 lines (59 loc) · 3.7 KB
Raw

GraphAcademy Course Content

This repository holds the course curriculum for GraphAcademy.

Starting the Server

This repository uses docker-compose to create a local server using the latest production build of the GraphAcademy website (repo here). The docker image is stored on AWS ECR, so you will need credentials - talk to Adam.

  1. Install the AWS CLI

  2. Add your credentials to the ~/.aws/credentials file.

    aws_access_key_id = XXX
aws_secret_access_key = XXX

    1. If you already have credentials in this file, you can add a new profile by adding a header above credentials. For example [ga].

      [ga]
aws_access_key_id = XXX
aws_secret_access_key = XXX+8Yk4bLQQCKOdBME1i7e

  3. Log in to docker using the credentials above:

    aws ecr get-login-password --region us-east-1 | docker login -u AWS --password-stdin 715633473519.dkr.ecr.us-east-1.amazonaws.com

  4. Run docker-compose up to start a new Neo4j instance and the GraphAcademy server.

File Structure

All content lives in the asciidoc/ directory. As you modify the content, a process will sync the content

  • categories/ - Category information

  • courses/ - All courses are organised into the own folder structure with modules and lessons

  • emails/ - The emails sent to users on enrolment, completion and a reminder email when the user has been inactive for 7 days

  • languages/ - i18n phrases for courses in languages other than English.

  • pages/ - "CMS" content displayed throughout the website, for example the /certifications/ oage

  • shared/ - Content shared across courses

  • statuses/ - Meta data around course statuses

Course Structure

  • Coming soon

Multi-language Support

  • Coming soon

QA

A suite of tests have been setup to ensure courses meet the right standard.

To open the test suite run:

npm run test

This will open up a UI. Select E2E testing > Chrome and then select the course.

To create a test for your course, you can copy one of the existing files in the cypress/e2e folder to cypress/e2e/{slug}.cy.js and then change line 6 to cy.getCourseDetails('{slug}')/

Contributing

To create a new course or modify an existing course, please create a new branch and make your changes. Once you have finished, create a new PR and add adam-cowley as a reviewer.

git checkout -b new-course
mkdir asciidoc/courses/new-course/
echo "= New Course\n:status: draft" > asciidoc/courses/new-course/course.adoc
git add asciidoc/courses/new-course/
git commit -m "Added new course"
git push --set-upstream origin new-course

Before creating the PR, please rebase your branch on the main branch.

git fetch origin main
git rebase main

Deploying Changes

When a new application server is created, the latest tagged version of this repository is downloaded by the server.

You can use the npm version command to create a new tag.

npm version patch
git push --tags origin main

  • npm version patch - To be used when minor fixes are made to an existing course

  • npm version minor - To be used when a new course is released

  • npm version major - To be used when a major change is made to the repository - for example, multiple course changes, or addition of a new category

If you have correct privileges, you can restart the cluster by running the following command:

kubectl rollout restart deployment/graphacademy -n graphacademy-prod