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

Unify Basic tools installation #106

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Unify Basic tools installation #106

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
215f338
Reformulate prerequisites to bullet points
panitram Apr 25, 2021
88e5f61
Capitalise Android
panitram Apr 25, 2021
30b708e
Unify the procedure for installation
panitram Apr 25, 2021
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
40 changes: 11 additions & 29 deletions odkx-src/basics-install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,10 @@ These instructions describe the steps to install the ODK-X basic tools on a tabl
Prerequisites
-------------------

You must have an Android tablet with an operating system version 4.4 or higher.

If you are working on a Windows/Mac/Linux machine, you can use `Android Studio <https://developer.android.com/studio>`_ to launch an Android emulator for testing purposes.

Please note that ODK-X Services version 2.1.7 doesn't work on Android 11. You will need Android 10 with API level less than 30 for version 2.1.7.

Before installing any of the ODK-X tools, you will need the following third party app:

- `OI File Manager <https://github.com/openintents/filemanager/releases>`_
- An Android tablet with an operating system version 4.4 or higher. If you are working on a Windows/Mac/Linux machine, you can use `Android Studio <https://developer.android.com/studio>`_ to launch an Android emulator for testing purposes.
- Android 10 with API level less than 30 for version 2.1.7.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes it sound like you have to have Android 10, that this is a pre-requisite.

I think the original text in this section was clearer, as it was complete sentences (the first pre-requisite in the revised is a fragment) and made clear the issue with Android 10.

Please note that ODK-X Services version 2.1.7 doesn't work on Android 11.
- The following third party app: `OI File Manager <https://github.com/openintents/filemanager/releases>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original directions are much clearer in stating that Before installing, you will need the app (also a complete sentence in the original)


Required
~~~~~~~~~~~~~~~
Expand All @@ -34,7 +29,7 @@ We also recommend installing both ODK-X Survey and ODK-X Tables. Having both is
Installing Services
--------------------------------

1. From your device's :guilabel:`Settings`, choose :menuselection:`Apps & notifications`. (On older versions of Android, this setting maybe in :menuselection:`Applications` or :menuselection:`Security` depending upon your android version.)
1. From your device's :guilabel:`Settings`, choose :menuselection:`Apps & notifications`. (On older versions of Android, this setting maybe in :menuselection:`Applications` or :menuselection:`Security` depending upon your Android version.)

- Go to :guilabel:`Special app access` in :guilabel:`Advanced` and choose :guilabel:`Install unknown apps`
- From the list of applications, select a browser of your choice and check :guilabel:`Allow from this source`.
Expand All @@ -60,15 +55,9 @@ Installing Services
Installing the ODK-X Survey App
-----------------------------------

1. From your device's :guilabel:`Settings`, choose :menuselection:`Apps & notifications`. (On older versions of Android, this setting maybe in :menuselection:`Applications` or :menuselection:`Security` depending upon your android version.)

- Go to :guilabel:`Special app access` in :guilabel:`Advanced` and choose :guilabel:`Install unknown apps`
- From the list of applications, select a browser of your choice and check :guilabel:`Allow from this source`.
- (On older versions of Android, above two steps are not required, make sure installation from *Unknown Sources* is checked.)

2. Open the same web browser that you authorized to install unknown apps on your Android device. (For older versions of Android any web browser can be used since you do not need to specifically authorize the web browser's ability to install.)
3. Navigate to https://github.com/odk-x/survey/releases/latest and download the latest ODK-X Survey APK.
4. In the download window, you will see ODK_Survey.N.N.apk. - Select it to download the file.
1. Open the same web browser that you authorized to install unknown apps on your Android device. (For older versions of Android any web browser can be used since you do not need to specifically authorize the web browser's ability to install.)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would mention and link to this step in installing services where you did this so it is clear what is being referred to, and in case anyone tries to do the steps out of order they know what they need to do.

2. Navigate to https://github.com/odk-x/survey/releases/latest and download the latest ODK-X Survey APK.
3. In the download window, you will see ODK_Survey.N.N.apk. - Select it to download the file.

- On older devices, the APK will automatically install after you approve the security settings.
- On newer devices, you must go to the download list, rename the file to restore the .apk extension (the extension will have been renamed to .man during the download process), then click on it to install it.
Expand All @@ -87,16 +76,9 @@ Installing the ODK-X Survey App
Installing the ODK-X Tables App
-----------------------------------


1. From your device's :guilabel:`Settings`, choose :menuselection:`Apps & notifications`. (On older versions of Android, this setting maybe in :menuselection:`Applications` or :menuselection:`Security` depending upon your android version.)

- Go to :guilabel:`Special app access` in :guilabel:`Advanced` and choose :guilabel:`Install unknown apps`
- From the list of applications, select a browser of your choice and check :guilabel:`Allow from this source`.
- (On older versions of Android, above two steps are not required, make sure installation from *Unknown Sources* is checked.)

2. Open the same web browser that you authorized to install unknown apps on your Android device. (For older versions of Android any web browser can be used since you do not need to specifically authorize the web browser's ability to install.)
3. Navigate to https://github.com/odk-x/tables/releases/latest and download the latest ODK-X Tables APK.
4. In the download window, you will see ODK_Tables.N.N.apk. - Select it to download the file.
1. Open the same web browser that you authorized to install unknown apps on your Android device. (For older versions of Android any web browser can be used since you do not need to specifically authorize the web browser's ability to install.)
2. Navigate to https://github.com/odk-x/tables/releases/latest and download the latest ODK-X Tables APK.
3. In the download window, you will see ODK_Tables.N.N.apk. - Select it to download the file.

- On older devices, the APK will automatically install after you approve the security settings.
- On newer devices, you must go to the download list, rename the file to restore the .apk extension (the extension will have been renamed to .man during the download process), then click on it to install it.
Expand Down