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

Made some changes for better readabilty, and understanding of the tex… #288

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

Made some changes for better readabilty, and understanding of the tex… #288

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
beddb27
Made some changes for better readabilty, and understanding of the tex…
Arnav2824 Mar 24, 2024
8314659
Changed the slash style in line 182 in app-
Arnav2824 Mar 25, 2024
f2965ba
Changed the slashes back to what they were in the
Arnav2824 Mar 26, 2024
df3d06c
Changed the slashes in line 192 and 199 to what
Arnav2824 Mar 26, 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
12 changes: 6 additions & 6 deletions src/app-designer-prereqs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

period after (WSL) should be a comma. Is the acronym needed? If not used elsewhere, can skip here.

Copy link
Member

Choose a reason for hiding this comment

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

keeping WSL is okay helps when reading other documentation as often referred to as WSL


.. _app-designer-prereqs-java:

Expand Down Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

incorrect on mac/unix slashes go other way and it's under the mac section.
Like this part of the documentation: https://docs.odk-x.org/docs-tech-guide/#before-you-begin
notice the "bash" and "PowerShell" tabs to explain the difference

$ \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:
Expand All @@ -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) <https://developer.android.com/studio/command-line/adb.html>`_ 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

Expand Down
2 changes: 1 addition & 1 deletion src/cold-chain-tour-health-facilities.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/contributing-tips.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/services-managing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion src/tables-sample-app-tea-houses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down