From 8d4e5424bd11633c218e7a7ac498959d806e0c55 Mon Sep 17 00:00:00 2001 From: Brian Mesick <112640379+bmtcril@users.noreply.github.com> Date: Mon, 22 Jul 2024 19:47:03 -0400 Subject: [PATCH] docs: Update readme to include the Superset image (#904) --- README.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index a1f8522fe..f97b82421 100644 --- a/README.rst +++ b/README.rst @@ -43,10 +43,14 @@ Aspects is implemented as a Tutor plugin. Documentation will be coming soon to c tutor config save -#. Because we're installing new applications in LMS (event-routing-backends, event-sink-clickhouse) you will need to rebuild your openedx image:: +#. Because we're installing new applications in LMS (event-routing-backends, event-sink-clickhouse) you will need to rebuild your openedx Docker image:: tutor images build openedx --no-cache +#. Build the Aspects-flavored Superset image to bake your settings (such as database passwords) into the Superset assets:: + + tutor images build aspects-superset + #. Run the initialization scripts:: tutor local do init @@ -198,7 +202,7 @@ However, please keep in mind that the assets declaration is itself a jinja templ Releasing tutor-contrib-aspects ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Changelog, package version, PyPI release, and image building are all handled via manually triggered Githib Actions. +Changelog, package version, PyPI release, and image building are all handled via manually triggered Githib Actions. To trigger a build you must have access to manually trigger the "Bump version and changelog" action. This will update the version and changelog in a new PR. If the PR looks good, you can approve and merge it. Merging this PR will: