Skip to content

Latest commit

 

History

History
79 lines (61 loc) · 2.96 KB

update-existing-course.adoc

File metadata and controls

79 lines (61 loc) · 2.96 KB

Updating an existing course

The repos used for GraphAcademy courses include:

Course content:

Files that support a course:

Note
 All updates to the course repo should have their own branches that are off of main. The exception to this are the files for a course where all work is done off of main (no branches) Ideally, you should update one course at a time so that all updates for the PR will be related to the same course.

Updating course content

If a course lesson/challenge/questions change, then you must use these steps to update a course.

Note
 You need not change course files if your changes only apply to the files for supporting a course (the app-** and importing-data repos)

  1. If you have not done so already, clone the git repo for a course: https://github.com/neo4j-graphacademy/courses

    1. git checkout main

    2. git pull origin main

    3. If there is already a local branch:

      1. git branch -a to see local branches

      2. git checkout <local branch name>

    4. If there is no local branch:

      1. git branch -a to see local branches

      2. git checkout -b <local branch name>

      3. git pull origin main

    5. Edit the course in your asciidoc editor of choice

    6. Commit your changes to the branch in the repo:

      1. git status (to see files modified/deleted/added)

      2. git add *

      3. git status (to see files to be committed)

      4. git commit -m "description of the changes"

      5. git push origin <local branch name>

    7. If ready to, create a Pull Request for the branch

      1. Go to https://github.com/neo4j-graphacademy/courses and go to the branch you just committed

      2. Add a Pull Request

      3. Add a title and if need be, a description of the PR

      4. Add reviewers for the PR if you want it reviewed

    8. If you have the review needed and are ready to merge, merge the PR

Next:

  1. Update course supporting files (if applicable)

  2. Deploy the course and/or supporting file changes (see deploy-merged-prs.adoc)

Updating course’s supporting files

Note
 Make sure that any changes to a course’s support files do not warrant a change to a lesson/challenge/question. If so you must also update the course files.

  1. If you have not done so already, clone the git repo for a course supporting files.

    1. [copy]git checkout main

    2. git pull origin main

    3. Edit the course in your asciidoc editor of choice

    4. Commit your changes to the repo:

      1. git status (to see files modified/deleted/added)

      2. git add *

      3. git status (to see files to be committed)

      4. git commit -m "description of the changes"

      5. git push

Next:

  1. Deploy the course and/or supporting file changes (see deploy-merged-prs.adoc)