Unify Basic tools installation #106
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bullet points are easier to read. It's also better to start with the info which Android version the user needs and then tell them why (or additional info).
Delete the first repetetive step in Survey and Tables installation, because is already mentioned in Services. Services are a prerequisite for all other apps. By the time the user installs Survey or Tables, they have already performed this step.
elmps2018
reviewed
Apr 25, 2021
|
|
||
| - `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. |
There was a problem hiding this comment.
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.
| - 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. | ||
| 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>`_. |
There was a problem hiding this comment.
The original directions are much clearer in stating that Before installing, you will need the app (also a complete sentence in the original)
| 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.) |
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is included in this PR?
Correcting the chapter: Installing ODK-X Basic Tools
I was testing the installation and in one point I was repeating my steps. I tried to make the instructions shorter, so I deleted this step in Tables and Survey installation - it already occurs in the installation of Services (which is a prerequisite).
Then, changed the formatting in Prerequisites to bullet points as it is easier to read. I deleted then redundant verbs in this section.