From c94ecf9296274faa7911da327bf0f4dd388b9c66 Mon Sep 17 00:00:00 2001 From: Jhony Avella Date: Wed, 22 Feb 2023 19:44:06 -0500 Subject: [PATCH] chore: addressing PR review comments --- README.rst | 6 +++--- tutornotes/plugin.py | 4 ++-- tutornotes/templates/notes/build/notes/Dockerfile | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 77ca164..52d1b91 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ Students notes plugin for `Tutor `_ =================================================================== -This is a plugin for `Tutor `_ to easily add the `Open edX note-taking app `_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation `_). +This is a plugin for `Tutor `_ to easily add the `Open edX note-taking app `_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation `_). .. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-olive.master/_images/SFD_SN_bodyexample.png :alt: Notes in action @@ -33,8 +33,8 @@ Configuration - ``NOTES_HOST`` (default: ``"notes.{{ LMS_HOST }}"``) - ``NOTES_MYSQL_DATABASE`` (default: ``"notes"``) - ``NOTES_MYSQL_USERNAME`` (default: ``"notes"``) -- ``NOTES_CODE_REPO`` (default: ``"https://github.com/edx/edx-notes-api"``) -- ``NOTES_CODE_VERSION`` (default: ``"{{ OPENEDX_COMMON_VERSION }}"``) +- ``NOTES_REPOSITORY`` (default: ``"https://github.com/openedx/edx-notes-api"``) +- ``NOTES_COMMON_VERSION`` (default: ``"{{ OPENEDX_COMMON_VERSION }}"``) These values can be modified with ``tutor config save --set PARAM_NAME=VALUE`` commands. diff --git a/tutornotes/plugin.py b/tutornotes/plugin.py index e2a5825..652fefc 100644 --- a/tutornotes/plugin.py +++ b/tutornotes/plugin.py @@ -20,8 +20,8 @@ "HOST": "notes.{{ LMS_HOST }}", "MYSQL_DATABASE": "notes", "MYSQL_USERNAME": "notes", - "CODE_REPO": "https://github.com/edx/edx-notes-api", - "CODE_VERSION": "{{ OPENEDX_COMMON_VERSION }}", + "REPOSITORY": "https://github.com/openedx/edx-notes-api", + "COMMON_VERSION": "{{ OPENEDX_COMMON_VERSION }}", }, } diff --git a/tutornotes/templates/notes/build/notes/Dockerfile b/tutornotes/templates/notes/build/notes/Dockerfile index d75a1a0..80ccc73 100644 --- a/tutornotes/templates/notes/build/notes/Dockerfile +++ b/tutornotes/templates/notes/build/notes/Dockerfile @@ -10,7 +10,7 @@ ARG APP_USER_ID=1000 RUN useradd --home-dir /app --create-home --shell /bin/bash --uid ${APP_USER_ID} app USER ${APP_USER_ID} -RUN git clone {{ NOTES_CODE_REPO }} --branch {{ NOTES_CODE_VERSION }} --depth 1 /app/edx-notes-api +RUN git clone {{ NOTES_REPOSITORY }} --branch {{ NOTES_COMMON_VERSION }} --depth 1 /app/edx-notes-api WORKDIR /app/edx-notes-api RUN python -m venv /app/venv