Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: wrong variable name to enable PII #283

Merged
merged 2 commits into from
Oct 15, 2024
Merged

fix: wrong variable name to enable PII #283

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bdf143
fix: no USER in ASPECTS_ENABLE_PII
CodeWithEmad Oct 13, 2024
5d2f4d1
chore: command instructions to enable PII added
CodeWithEmad Oct 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/technical_documentation/how-tos/production_configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,12 @@ Personally Identifiable Identification

By default Aspects does not store information that can directly link the xAPI learning traces to an individual's name, email address, username, etc. Storing this information has potential legal consequences and should be undertaken with careful consideration.

Setting ``ASPECTS_ENABLE_USER_PII`` to ``True``, then running Tutor init for the Aspects plugin, turns on the ability to send user data to ClickHouse. When turned on this populates the ``event_sink.external_id`` and ``event_sink.user_profile`` tables as new users are created.
Setting ``ASPECTS_ENABLE_PII`` to ``True``, then running Tutor init for the Aspects plugin, turns on the ability to send user data to ClickHouse. When turned on this populates the ``event_sink.external_id`` and ``event_sink.user_profile`` tables as new users are created.

.. code-block:: bash

tutor config save -s ASPECTS_ENABLE_PII=true
tutor dev|local|k8s do init -l aspects

However it does not copy over existing users, see :ref:`Backfilling Existing Data` below for more information on how to do that.

Expand Down Expand Up @@ -256,7 +261,7 @@ There is a management command to populate course data for one, all, or a subset
tutor local run lms ./manage.py lms dump_data_to_clickhouse --object course_overviews


If you are running with ``ASPECTS_ENABLE_USER_PII`` set to ``True`` you will need to populate the user PII data with these commands:
If you are running with ``ASPECTS_ENABLE_PII`` set to ``True`` you will need to populate the user PII data with these commands:

.. code-block::

Expand Down