Skip to content

Commit

Permalink
Merge pull request #5 from Esri/mike/doc-update-0.1.1
Browse files Browse the repository at this point in the history
Improvements to app documentation
  • Loading branch information
mikewilburn authored Jul 30, 2020
2 parents be7d1a4 + 42452db commit f122cfb
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 4 deletions.
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Data Collection Android

<!-- MDTOC maxdepth:6 firsth1:0 numbering:0 flatten:0 bullets:1 updateOnSave:1 -->

- [SDK Usage](#sdk-usage)
- [Detailed Documentation](#detailed-documentation)
- [Development Instructions](#development-instructions)
- [Fork the repo](#fork-the-repo)
- [Clone the repo](#clone-the-repo)
- [Command line Git](#command-line-git)
- [Configuring a Remote for a Fork](#configuring-a-remote-for-a-fork)
- [Requirements](#requirements)
- [Resources](#resources)
- [Issues](#issues)
- [Contributing](#contributing)
- [MDTOC](#mdtoc)
- [Licensing](#licensing)

<!-- /MDTOC -->
---

Data Collection for Android shows how a robust application can be built around the ArcGIS Platform using the ArcGIS Runtime SDK for Android and Kotlin. It demonstrates best practices around some simple but key functionality of the ArcGIS Runtime. Using your organization's web maps, you can use Data Collection as is, or extend it to meet your specific needs.

![General UI](./docs/images/General-UI.png)
Expand All @@ -12,7 +31,12 @@ Mobile Data Collection leverages several aspects of the Runtime SDK including:
* Portal authentication with OAuth 2.0
* Working with Features, Popups and PopupManagers

## Detailed Documentation

Read the [docs](./docs/README.md) for a detailed explanation of the application, including its architecture and how it leverages the ArcGIS platform, as well as how you can begin using the app right away.

## Development Instructions

Data Collection is an [Android Studio](http://developer.android.com/sdk/index.html) project and app module that can be directly cloned and imported into Android Studio.

1. Log in to [ArcGIS for Developers](https://developers.arcgis.com/) and [register](https://developers.arcgis.com/applications/#/) your app.
Expand Down Expand Up @@ -56,17 +80,21 @@ Data Collection is an [Android Studio](http://developer.android.com/sdk/index.ht
```

### Fork the repo

**Fork** the [Data Collection for Android](https://github.com/Esri/data-collection-android/fork) repo.

### Clone the repo

Once you have forked the repo, you can make a local clone.

#### Command line Git

1. [Clone the Data Collection for Android repo](https://help.github.com/articles/fork-a-repo#step-2-clone-your-fork)
2. ```cd``` into the ```data-collection-android``` folder
3. Make your changes and create a [pull request](https://help.github.com/articles/creating-a-pull-request)

### Configuring a Remote for a Fork

If you make changes in the fork and would like to [sync](https://help.github.com/articles/syncing-a-fork/) those changes with the upstream repository, you must first [configure the remote](https://help.github.com/articles/configuring-a-remote-for-a-fork/). This will be required when you have created local branches and would like to make a [pull request](https://help.github.com/articles/creating-a-pull-request) to your upstream branch.

1. In the Terminal (for Mac users) or command prompt (fow Windows and Linux users) type ```git remote -v``` to list the current configured remote repo for your fork.
Expand All @@ -77,12 +105,14 @@ If there are changes made in the original repository, you can sync the fork to k
1. In the terminal, change the current working directory to your local project.
2. Type ```git fetch upstream``` to fetch the commits from the upstream repository.
3. ```git checkout master``` to checkout your fork's local master branch.
4. ```git merge upstream/master``` to sync your local `master' branch with `upstream/master`. **Note**: Your local changes will be retained and your fork's master branch will be in sync with the upstream repository.
4. ```git merge upstream/master``` to sync your local `master` branch with `upstream/master`. **Note**: Your local changes will be retained and your fork's master branch will be in sync with the upstream repository.

## Requirements

* [Android Studio](http://developer.android.com/sdk/index.html)

## Resources

* [ArcGIS Runtime SDK for Android Developers Site](https://developers.arcgis.com/android/)
* [ArcGIS Mobile Blog](http://blogs.esri.com/esri/arcgis/category/mobile/)
* [ArcGIS Developer Blog](http://blogs.esri.com/esri/arcgis/category/developer/)
Expand All @@ -101,7 +131,11 @@ Anyone and everyone is welcome to contribute. We do accept pull requests.
3. Contribute code
4. Improve documentation

### Licensing
## MDTOC

Generation of this and other documents' table of contents in this repository was performed using the [MDTOC package for Atom](https://atom.io/packages/atom-mdtoc).

## Licensing

Copyright 2020 Esri

Expand Down
5 changes: 5 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Release 0.1.1

- Adds doc table of contents to root README.md and docs/index.md
- Renames docs/index.md to [docs/README.md](/docs/README.md)

# Release 0.1

**Initial Release**
Expand Down
2 changes: 1 addition & 1 deletion app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ android {
minSdkVersion 23
targetSdkVersion 29
versionCode 1
versionName "1.0"
versionName "0.1.1"
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
buildTypes {
Expand Down
2 changes: 1 addition & 1 deletion app/src/main/res/values/strings.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<resources>
<string name="app_name">Data Collection</string>
<string name="app_name_with_version">Data Collection %s</string>
<string name="app_version">0.1</string>
<string name="app_version">0.1.1</string>

<string name="arcgis_runtime_sdk">ArcGIS Runtime SDK %s</string>

Expand Down
25 changes: 25 additions & 0 deletions docs/index.md → docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# Data Collection for Android documentation

<!-- MDTOC maxdepth:6 firsth1:0 numbering:0 flatten:0 bullets:1 updateOnSave:1 -->

- [Description](#description)
- [Generic application](#generic-application)
- [Portland Tree Survey](#portland-tree-survey)
- [Using the app](#using-the-app)
- [Manage the app's context](#manage-the-apps-context)
- [Sign in and out of portal](#sign-in-and-out-of-portal)
- [Identify map features](#identify-map-features)
- [View data with pop-ups](#view-data-with-pop-ups)
- [Using web maps](#using-web-maps)
- [Configure web map & feature services for Data Collection](#configure-web-map-feature-services-for-data-collection)
- [Map title](#map-title)
- [Organizing feature layers](#organizing-feature-layers)
- [Feature layer visibility range](#feature-layer-visibility-range)
- [Enable editing on feature layers and tables](#enable-editing-on-feature-layers-and-tables)
- [Enable pop-up on feature layers and tables](#enable-pop-up-on-feature-layers-and-tables)
- [Configure pop-up on feature layers and tables](#configure-pop-up-on-feature-layers-and-tables)
- [Authentication model](#authentication-model)
- [Using map definition & pop-up configurations to drive app behavior](#using-map-definition-pop-up-configurations-to-drive-app-behavior)
- [Map identify rules](#map-identify-rules)

<!-- /MDTOC -->
---

## Description

Collect data in an app consuming your organization's web map driven by the ArcGIS Web GIS information model. Use the example _Portland Tree Survey_ web map and dataset to get started.
Expand Down

0 comments on commit f122cfb

Please sign in to comment.