From beddb2790d1ce237347faad8447f6fd83415f36c Mon Sep 17 00:00:00 2001 From: Arnav Puri Date: Sun, 24 Mar 2024 23:26:19 +0530 Subject: [PATCH 1/4] Made some changes for better readabilty, and understanding of the text to avoid any confusion for the contributors. --- src/app-designer-prereqs.rst | 12 ++++++------ src/cold-chain-tour-health-facilities.rst | 2 +- src/contributing-tips.rst | 4 ++-- src/services-managing.rst | 2 +- src/tables-sample-app-tea-houses.rst | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/app-designer-prereqs.rst b/src/app-designer-prereqs.rst index 687e7ba3..793e021e 100644 --- a/src/app-designer-prereqs.rst +++ b/src/app-designer-prereqs.rst @@ -37,7 +37,7 @@ You must install the following software on your computer in order to use Applica .. warning:: - Android Studio is not supported on the Windows Linux subsystem, so you will not be able to run Application Designer if you are using it. + Android Studio is not supported on the Windows Subsystem for Linux (WSL). so you will not be able to run Application Designer if you are using it. .. _app-designer-prereqs-java: @@ -178,8 +178,8 @@ To install the Android SDK: .. code-block:: console - $ /Android/cmdline-tools/latest/bin> - $ /Android/cmdline-tools/latest/bin>sdkmanager.bat --list + $ \Android\cmdline-tools\latest\bin + $ \Android\cmdline-tools\latest/bin>sdkmanager.bat --list 9. Select the latest versions of the following packages by typing :guilabel:`sdkmanager` followed by the package path wrapped in quotes and separated by a space: @@ -189,21 +189,21 @@ To install the Android SDK: .. code-block:: console - $ /Android/cmdline-tools/latest/bin>sdkmanager "platform-tools" "build-tools;30.0.3" + $ \Android\cmdline-tools\latest\bin>sdkmanager "platform-tools" "build-tools;30.0.3" If there are extra packages you wish to install, you may add them by passing the package path wrapped in quotes, separated with a space. .. code-block:: console - $ /Android/cmdline-tools/latest/bin>sdkmanager "platform-tools" "build-tools;30.0.3" "extra-package-path" + $ \Android\cmdline-tools\latest\bin>sdkmanager "platform-tools" "build-tools;30.0.3" "extra-package-path" 10. Accept the license agreement(s) by entering :guilabel:`y` to the :guilabel:`Accept? (y/N):` prompt. Among many other things, this will install the Android Debug Bridge software on your computer. This tool enables the scripted pushing of files and APKs down to your Android device. See `adb (Android Debug Bridge) `_ for a listing of its capabilities. -Next, on Windows open a :program:`PowerShell` or :program:`cmd` window and on Mac/Unix open a :program:`terminal` window. Type: +Next, on Windows open a :program:`PowerShell` or :program:`cmd` window and on Mac/Unix, open a :program:`terminal` window. Type: .. code-block:: console diff --git a/src/cold-chain-tour-health-facilities.rst b/src/cold-chain-tour-health-facilities.rst index 17192b02..2c87829e 100644 --- a/src/cold-chain-tour-health-facilities.rst +++ b/src/cold-chain-tour-health-facilities.rst @@ -25,7 +25,7 @@ The list of health facilities is presented as a *Map View*. The list portion of - **View All Health Facilities**: This screen is reached by pressing the :guilabel:`View All Health Facilities` button on the :ref:`cold-chain-tour-regions-menu` page. It lists every health facility located inside of the specified region. It is pictured above. - - **Filter Health Facilities By Type**: This screen is reached by pressing the :guilabel:`Filter Health Facilities by Type` button on the :ref:`cold-chain-tour-regions-menu` page. It lists each type of health facility contained in the region, and a the number of health facilities that match the type: + - **Filter Health Facilities By Type**: This screen is reached by pressing the :guilabel:`Filter Health Facilities by Type` button on the :ref:`cold-chain-tour-regions-menu` page. It lists each type of health facility contained in the region, and the number of health facilities that match the type: .. image:: /img/cold-chain-tour/cold-chain-health-facility-list-region-nav.* :alt: Health Facility Types diff --git a/src/contributing-tips.rst b/src/contributing-tips.rst index 7be50d88..40336260 100644 --- a/src/contributing-tips.rst +++ b/src/contributing-tips.rst @@ -61,7 +61,7 @@ Discuss issues before working Take the time to clarify the needs and scope of an issue before committing to work on it. Especially for coding tasks, make sure you state your understanding and your plan before working. -If you have a question, ask. Don't guess. +If you have a question, ask. Don't make assumptions. .. note:: @@ -115,7 +115,7 @@ If you get stuck while working It is okay to abandon an issue ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sometimes you simply cannot complete work you have said you were going to complete. This could happen because you don't have all the required skills or knowledge to complete the work, or because the issue cannot actually be completed as scoped, or because you don't have the time. +Sometimes you simply cannot complete work you have said you were going to complete. This could happen if you lack the necessary skills or knowledge to complete the work, or because the issue cannot actually be completed as scoped, or because you don't have the time. Please let the community know in the issue discussion. You can do that by leaving a comment asking to be unassigned from the issue. diff --git a/src/services-managing.rst b/src/services-managing.rst index 8f4e75ab..f5ac4f4c 100644 --- a/src/services-managing.rst +++ b/src/services-managing.rst @@ -10,7 +10,7 @@ Managing ODK-X Services Prerequisites --------------------- -ODK-X Services is a prerequisite to all Data Management Application. You will also need the ODK-X tools: +ODK-X Services is a prerequisite to all Data Management Applications. You will also need the ODK-X tools: - :doc:`app-designer-intro` - :doc:`cloud-endpoints-intro` diff --git a/src/tables-sample-app-tea-houses.rst b/src/tables-sample-app-tea-houses.rst index ca53d42d..6d72bc1d 100644 --- a/src/tables-sample-app-tea-houses.rst +++ b/src/tables-sample-app-tea-houses.rst @@ -51,7 +51,7 @@ List View This screen shows a list of all teas available in the *Tea Inventory* data table. This view is customized with HTML, CSS, and JavaScript. It provides a simple way to view and navigate collected data. As new teas are added to the inventory, this list view will grow. -To see the raw data, we will switch to *Spreadsheet View*. Tap on the lined paper icon at the top of the screen. Here you’ll see all the possible view types. Select :menuselection:`Spreadsheet`. +To view the raw data, we will switch to *Spreadsheet View*. Tap on the lined paper icon at the top of the screen. Here you’ll see all the possible view types. Select :menuselection:`Spreadsheet`. .. image:: /img/tables-sample-app/tables-sample-launch-spreadsheet.* :alt: Tea Houses Launch Spreadsheet View From 83146593f8bc9cd22485089140e28cf713f8293b Mon Sep 17 00:00:00 2001 From: Arnav Puri Date: Tue, 26 Mar 2024 01:08:47 +0530 Subject: [PATCH 2/4] Changed the slash style in line 182 in app- designer-prereqs.rst --- src/app-designer-prereqs.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/app-designer-prereqs.rst b/src/app-designer-prereqs.rst index 793e021e..51de918b 100644 --- a/src/app-designer-prereqs.rst +++ b/src/app-designer-prereqs.rst @@ -37,7 +37,7 @@ You must install the following software on your computer in order to use Applica .. warning:: - Android Studio is not supported on the Windows Subsystem for Linux (WSL). so you will not be able to run Application Designer if you are using it. + Android Studio is not supported on the Windows Subsystem for Linux (WSL), so you will not be able to run Application Designer if you are using it. .. _app-designer-prereqs-java: @@ -178,8 +178,8 @@ To install the Android SDK: .. code-block:: console - $ \Android\cmdline-tools\latest\bin - $ \Android\cmdline-tools\latest/bin>sdkmanager.bat --list + $ /Android/cmdline-tools/latest/bin + $ \Android\cmdline-tools\latest\bin>sdkmanager.bat --list 9. Select the latest versions of the following packages by typing :guilabel:`sdkmanager` followed by the package path wrapped in quotes and separated by a space: From f2965ba1435caed0ba2f5d1865ce0f40db98e7cc Mon Sep 17 00:00:00 2001 From: Arnav Puri Date: Tue, 26 Mar 2024 16:02:48 +0530 Subject: [PATCH 3/4] Changed the slashes back to what they were in the original documentation. --- src/app-designer-prereqs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/app-designer-prereqs.rst b/src/app-designer-prereqs.rst index 51de918b..6ad06407 100644 --- a/src/app-designer-prereqs.rst +++ b/src/app-designer-prereqs.rst @@ -179,7 +179,7 @@ To install the Android SDK: .. code-block:: console $ /Android/cmdline-tools/latest/bin - $ \Android\cmdline-tools\latest\bin>sdkmanager.bat --list + $ /Android/cmdline-tools/latest/bin>sdkmanager.bat --list 9. Select the latest versions of the following packages by typing :guilabel:`sdkmanager` followed by the package path wrapped in quotes and separated by a space: From df3d06cbce2527ec65e2bf5ff1f36bc7edc12370 Mon Sep 17 00:00:00 2001 From: Arnav Puri Date: Tue, 26 Mar 2024 20:45:17 +0530 Subject: [PATCH 4/4] Changed the slashes in line 192 and 199 to what they were in the original documentation. --- src/app-designer-prereqs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/app-designer-prereqs.rst b/src/app-designer-prereqs.rst index 6ad06407..7dbaafa1 100644 --- a/src/app-designer-prereqs.rst +++ b/src/app-designer-prereqs.rst @@ -189,14 +189,14 @@ To install the Android SDK: .. code-block:: console - $ \Android\cmdline-tools\latest\bin>sdkmanager "platform-tools" "build-tools;30.0.3" + $ /Android/cmdline-tools/latest/bin>sdkmanager "platform-tools" "build-tools;30.0.3" If there are extra packages you wish to install, you may add them by passing the package path wrapped in quotes, separated with a space. .. code-block:: console - $ \Android\cmdline-tools\latest\bin>sdkmanager "platform-tools" "build-tools;30.0.3" "extra-package-path" + $ /Android/cmdline-tools/latest/bin>sdkmanager "platform-tools" "build-tools;30.0.3" "extra-package-path" 10. Accept the license agreement(s) by entering :guilabel:`y` to the :guilabel:`Accept? (y/N):` prompt.