Skip to content

Match exactly and server settings updates #1242

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.

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

Merged
merged 21 commits into from
Sep 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 25 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ There are two options for building and viewing ODK docs locally: [using Docker](

## <a name="docker"></a>Using Docker

[Docker](https://www.docker.com/) is a platform that makes it easier to package applications so that they can work on any computer. This is particularly valuable when setting up development environments which can work very differently based on versions of the tools involved.
[Docker](https://www.docker.com/) is a platform that makes it easier to package applications so that they can work on any computer. This is particularly valuable when setting up development environments which can work very differently based on versions of the tools involved.

### Prerequisites
* Install Docker
* Windows and Mac users should follow the instructions in [the get started guide](https://www.docker.com/get-started)
* Linux users should follow the instructions for their specific distribution: [CentOS](https://docs.docker.com/install/linux/docker-ce/centos/), [Debian](https://docs.docker.com/install/linux/docker-ce/debian/), [Fedora](https://docs.docker.com/install/linux/docker-ce/fedora/), [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/), [Binaries](https://docs.docker.com/install/linux/docker-ce/binaries/)

More info at the [Docker CE docs page](https://docs.docker.com/install/)
* Install [git](https://git-scm.com/downloads)
* Install [Git-LFS](https://git-lfs.github.com/)
Expand All @@ -37,26 +37,14 @@ git clone https://github.com/getodk/docs.git

It can take a long time (>10 minutes) to clone the repo due to the large number of images in the docs. If you get an error such as `Smudge error` or `GitHub's rate limit reached`, run `git checkout -f HEAD` until you get the message `Checking out files: 100% done`.

### Building the Docker image

Next, you need to build the Docker image with all the tools you will be using to work with ODK's docs.
### Building and serving the docs locally

```
docker build -t odk-docs .
```

It can take a long time to build the Docker image, but you only need to do this once.

**Windows users**
* All commands should be run in an elevated PowerShell window. Right click on PowerShell and select the "Run as administrator" option.
* Ensure Docker is running by checking your system tray. If Docker is not running, launch "Docker for Windows" app and wait until a notification confirms that Docker is running.
Build and serve the docs locally with:
* Windows: `.\run.bat`
* Linux/macOS: `./run.sh`

### Building and serving the docs locally
This will build the Docker image with all the tools you will be using to work with ODK's docs which might take some time the first time you run the command.

Build and serve the docs locally with:
* Windows: `.\run-task.bat odk1-autobuild`
* Linux/macOS: `./run-task.sh odk1-autobuild`

Once your terminal shows a "Serving on http://0.0.0.0:8080" message, you can then view the docs in your browser at http://localhost:8080.

Changes you make in the source files will automatically be built and shown in your browser.
Expand All @@ -69,9 +57,18 @@ If you get a `The name "odk-docs" is already in use by container` error message,
docker kill odk-docs
```

**Windows users**
* All commands should be run in an elevated PowerShell window. Right click on PowerShell and select the "Run as administrator" option.
* Ensure Docker is running by checking your system tray. If Docker is not running, launch "Docker for Windows" app and wait until a notification confirms that Docker is running.

### Other build tasks

You can also use the `run-task` script described above to run just a portion of the build process. See available [build tasks](#tasks) below.
You can also use the `run-task` script to run just a portion of the build process:

* Windows: `.\run-task.bat <build-task>`
* Linux/macOS: `./run-task.sh <build-task>`

See available [build tasks](#tasks) below.

## <a name="python-environment"></a>Python environment

Expand All @@ -80,7 +77,7 @@ You can also use the `run-task` script described above to run just a portion of
* Install [Python 3](https://www.python.org/downloads/)
* Install [git](https://git-scm.com/downloads)
* Install [Git-LFS](https://git-lfs.github.com/)

We highly recommend you use a virtual environment like [virtualenv](https://virtualenv.pypa.io/en/stable/) or a Python version management like [pyenv](https://github.com/pyenv/pyenv). (Type `python --version` to see your current version.)

- Instructions for setting up virtual environment:
Expand All @@ -94,7 +91,7 @@ We highly recommend you use a virtual environment like [virtualenv](https://virt
#. Create the virtual environment.

.. tabs::

.. group-tab:: Bash

.. code:: console
Expand All @@ -112,7 +109,7 @@ We highly recommend you use a virtual environment like [virtualenv](https://virt
.. tabs::

.. group-tab:: Bash

.. code:: console

/odk/ $ source odkenv/bin/activate
Expand All @@ -127,15 +124,15 @@ We highly recommend you use a virtual environment like [virtualenv](https://virt

The ``(odkenv)`` before the prompt shows that the virtual environment is active.
You will need to have this active any time you are working on the docs.

If the file cannot be found, your activate file may be located under odkenv/scripts/activate.

Later, to deactivate the virtual environment:

.. tabs::

.. group-tab:: Bash

.. code:: console

(odkenv) /odk/ $ deactivate
Expand All @@ -147,7 +144,7 @@ We highly recommend you use a virtual environment like [virtualenv](https://virt

(odkenv) /odk/ > deactivate
/odk/ >


### Cloning the repo

Expand All @@ -161,7 +158,7 @@ $ pip install -r requirements.txt

It can take a long time (>10 minutes) to clone the repo due to the large number of images in the docs. If you get an error such as `Smudge error` or `GitHub's rate limit reached`, run `git checkout -f HEAD` until you get the message `Checking out files: 100% done`.

### Building the docs
### Building the docs
### Building the docs

Once your environment is set up, build and serve the docs locally with:
Expand Down Expand Up @@ -193,7 +190,7 @@ We are open for new issues and pull requests.
- First time contributors are encouraged to complete a [line edit](https://github.com/getodk/docs/issues/96) as a way to get familiar with our contribution process.
- Issues labelled [easy](https://github.com/getodk/docs/labels/easy) do not require much specific technical knowledge.
- Issues labelled [contributor friendly](https://github.com/getodk/docs/labels/contributor%20friendly) are usually self-contained and don't require extensive knowledge of the ODK ecosystem as a whole.

You can also...

- [Discuss the documentation from a user perspective in our forum](https://forum.getodk.org/c/development/documentation).
Expand All @@ -206,4 +203,3 @@ You can also...
- Make sure your virtual environment is activated.
- Type `python --version` to check your current python version (it should be 3.x).
- Run `pip install -r requirements.txt`.

61 changes: 0 additions & 61 deletions odk1-src/collect-connect-aggregate.rst

This file was deleted.

37 changes: 29 additions & 8 deletions odk1-src/collect-connect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ ODK Collect is used to fill forms with participants. Filled forms then need to b

When you first install Collect, it connects to `a demo server <https://opendatakit.appspot.com/Aggregate.html>`_. This allows you to try out the app by :ref:`downloading blank example forms <in-app-get-blank-forms>`, :doc:`filling them out <collect-filling-forms>`, and :ref:`uploading completed forms <uploading-forms>` back to the demo server.

Once you are done trying out Collect, you will need a plan for managing forms and data submissions. We recommend using `ODK Central <central-intro>` and configuring Collect by QR code. :doc:`ODK Central <central-intro>` provides user and project management features as well as tools for viewing and exporting data. For complex data collection projects, it is usually the right choice. Organizations can choose to use their own infrastructure and have total control over their server configuration. However, setting up and maintaining a server requires technical skills.
Once you are done trying out Collect, you will need a plan for managing forms and data submissions. We recommend using :ref:`ODK Central <central-intro>` and configuring Collect by QR code. :doc:`ODK Central <central-intro>` provides user and project management features as well as tools for viewing and exporting data. For complex data collection projects, it is usually the right choice. Organizations can choose to use their own infrastructure and have total control over their server configuration. However, setting up and maintaining a server requires technical skills.

Simple projects can choose to send data directly to Google Sheets.

Expand All @@ -14,15 +14,15 @@ Simple projects can choose to send data directly to Google Sheets.
Configure server from QR code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. From the Action Button (:guilabel:`⋮`), select :menuselection:`Configure via QR code`
#. From the Action Button (:guilabel:`⋮`), select :menuselection:`Configure via QR code`

.. image:: /img/collect-configure/quick-qr-code.*
:alt: Configure via QR code
:class: device-screen-vertical
.. image:: /img/collect-configure/quick-qr-code.*
:alt: Configure via QR code
:class: device-screen-vertical

1. Position the QR code in the center of the camera field, under the red line. When the camera focuses on the code, it will beep and scan the code.
#. Position the QR code in the center of the camera field, under the red line. When the camera focuses on the code, it will beep and scan the code.

1. Collect will apply the settings from the code and go back to the landing screen.
#. Collect will apply the settings from the code and go back to the landing screen.

.. seealso::

Expand All @@ -33,13 +33,34 @@ Configure server from QR code

.. _other-collect-server-options:

Configure server from settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#. From the Action Button (:guilabel:`⋮`), select :menuselection:`General Settings`


.. image:: /img/collect-connect/main-menu-highlight-kebab.*
:alt: The Main Menu screen of the Collect app. The three-dot 'kebab' menu in the upper-right corner is circled in red.

.. image:: /img/collect-connect/kebab-menu-general-settings.*
:alt: The Main Menu screen of the Collect App. A modal menu has unrolled in the top-right corner, with the option *About*, *General Settings*, and *Admin Settings*. *General Settings* is circled in red.

#. Select :guilabel:`Server`

.. image:: /img/collect-connect/general-settings-server.*
:alt: The General Settings menu in the Collect app. The options are *Server*, *User Interface*, *Form management*, and *User and device identity*. *Server* is circled in red.

#. Make sure :guilabel:`ODK` is selected under :guilabel:`Type` and then fill in the :guilabel:`URL`, :guilabel:`Username` and :guilabel:`Password` for your server:

.. image:: /img/collect-connect/server-settings-odk.*
:alt: The Server Settings screen in the Collect app. Below the *Type* option there are three items labeled *URL*, *Username*, and *Password*.

Other options
~~~~~~~~~~~~~~~

.. toctree::
:maxdepth: 1

collect-connect-google
collect-connect-aggregate
Transfering blank and completed forms directly with adb <collect-adb>
Using ODK Briefcase <briefcase-using>
9 changes: 8 additions & 1 deletion odk1-src/collect-forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,14 @@ Pulling Forms into Briefcase
Deleting Forms
===============

You can delete :formstate:`Blank` forms as well as filled forms in any state (:formstate:`Saved`, :formstate:`Finalized`, or :formstate:`Sent`). Deleting :formstate:`Blank` forms or filled forms in :formstate:`Saved` or :formstate:`Finalized` state removes every trace of that form definition or filled form. Deleting a :formstate:`Sent` form deletes the form contents but metadata associated with it including the deletion date and the instance name are maintained for display in the :guilabel:`View Sent Form` list.
.. warning::
In versions prior to v1.28, deleting a blank form makes it impossible to edit filled instances of that form.

In Collect v1.28 and later, filled instances of forms will still be editable after their blank form is deleted. This means that the form definition and media files will remain on the device until all the filled instances have been deleted.



You can delete :formstate:`Blank` forms as well as filled forms in any state (:formstate:`Saved`, :formstate:`Finalized`, or :formstate:`Sent`). Deleting a :formstate:`Sent` form deletes the form contents but metadata associated with it including the deletion date and the instance name are maintained for display in the :guilabel:`View Sent Form` list.

1. Select :guilabel:`Delete Saved Form` on the app home screen.

Expand Down
Loading