Skip to content

Commit

Permalink
update for #OPPIA-1309
Browse files Browse the repository at this point in the history
  • Loading branch information
alexlittle committed Oct 11, 2022
1 parent 2418d91 commit 531603f
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 29 deletions.
6 changes: 3 additions & 3 deletions support/training/tech/03_moodle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Activities
Follow up and preparation for next session
-------------------------------------------------------

* Create an account on https://mint.splunk.com/
* Create a Google Play Developer account (Google charges for this - currently 25 USD, but it's a one-off cost for as many apps as you like)
* Install Android Studio: https://developer.android.com/sdk/index.html
* Create a Google Play Developer account (Google charges for this - currently 25 USD, but it's a one-off cost for as
many apps as you like)
* Install Android Studio: https://developer.android.com/sdk/index.html
19 changes: 5 additions & 14 deletions technical/customise/app/buganalytics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,12 @@ To use Count.ly in Oppia all you need to do is add the following to your
COUNTLY_SERVER_URL=https://<url-to-your-countly-server>
COUNTLY_APP_KEY=<your-countly-app_key>

Splunk Mint
--------------

.. note::
From the end of Dec 2021, Splunk Mint will no longer be maintained, and is
due to be replaced by a new product from Splunk, although, at the time of
writing, full details of the new product have not been made available.
Therefore it is recommended not to use Splunk Mint for new implementations
of Oppia.

To use Splunk Mint in Oppia all you need to do is add the following to your
``custom.properties`` file (with the appropriate api key)::
Splunk Mint - no longer supported
----------------------------------

ANALYTICS_LIBRARY=MINT
MINT_API_KEY=<your-api_key>
As of Dec 2021, Splunk Mint is no longer maintained, so is no longer an option for opt-in analytics for the Oppia app
(option removed in :ref:`app version 7.3.14<appv104>`)


Adding another plugin/service
-------------------------------
Expand Down
18 changes: 6 additions & 12 deletions technical/customise/app/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,12 @@ List of configurable values

General settings
^^^^^^^^^^^^^^^^^
* ``ANALYTICS_LIBRARY`` (string): Defines the analytics/bug report library to
use. If left empty or not present, no analytics will be tracked. Currently,
Oppia supports two possible values (uppercase): ``MINT`` for **Splunk Mint**,
``COUNTLY`` for **Countly**.
* ``COUNTLY_APP_KEY`` (string): the Countly API key to use for the bug/analytics
reports
* ``COUNTLY_SERVER_URL`` (string): the URL for the Countly server instance to
use for the bug/analytics reports
* ``MINT_API_KEY`` (string): the Splunk Mint API key to use for the crash
reports
* ``OPPIA_SERVER_DEFAULT`` (string): the initial Oppia server URL. By default,
the demo server ``https://demo.oppia-mobile.org/``
* ``ANALYTICS_LIBRARY`` (string): Defines the analytics/bug report library to use. If left empty or not present, no
analytics will be tracked. Currently, Oppia supports only (uppercase): ``COUNTLY`` for **Countly**.
* ``COUNTLY_APP_KEY`` (string): the Countly API key to use for the bug/analytics reports
* ``COUNTLY_SERVER_URL`` (string): the URL for the Countly server instance to use for the bug/analytics reports
* ``OPPIA_SERVER_DEFAULT`` (string): the initial Oppia server URL. By default, the demo server
``https://demo.oppia-mobile.org/``
* ``OPPIA_SERVER_HOST`` (string): the server hostname, for the intent filter
functionality (to be able to open links from external apps directly in the
app). For example, if our server is ``https://demo.oppia-mobile.org/`` this
Expand Down
6 changes: 6 additions & 0 deletions technical/releases/app/changelog_android_v7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,14 @@ OppiaMobile Android App Change Log v7.x
v104 (7.3.14) - not yet released
-------------------------------------------------------

.. note::
If you are using Splunk Mint for the opt-in analytics, you must now move to Count.ly (or no opt-in analytics),
Splunk Mint is no longer active, and no crash/analytics will be recorded by their systems anyway

Issue list:

* OPPIA-1309 Remove Splunk Mint library option for analytics (Project entered End of Life)


.. _appv103:

Expand Down

0 comments on commit 531603f

Please sign in to comment.