Update documentation (Flank#686)

Author: pawelpasterz

README.md

@@ -1,4 +1,4 @@
-# Flank [![Build Status](https://app.bitrise.io/app/9767f3e19047d4db/status.svg?token=uDM3wCumR2xTd0axh4bjDQ&branch=master)](https://app.bitrise.io/app/9767f3e19047d4db) [![codecov](https://codecov.io/gh/TestArmada/flank/branch/master/graph/badge.svg)](https://codecov.io/gh/TestArmada/flank) [![pullreminders](https://pullreminders.com/badge.svg)](https://pullreminders.com?ref=badge)
+# Flank [![Build Status](https://app.bitrise.io/app/9767f3e19047d4db/status.svg?token=uDM3wCumR2xTd0axh4bjDQ&branch=master)](https://app.bitrise.io/app/9767f3e19047d4db) [![codecov](https://codecov.io/gh/Flank/flank/branch/master/graph/badge.svg)](https://codecov.io/gh/Flank/flank) [![pullreminders](https://pullreminders.com/badge.svg)](https://pullreminders.com?ref=badge)
 
 Flank is a [massively parallel Android and iOS test runner](https://docs.google.com/presentation/d/1goan9cXpimSJsS3L60WjljnFA_seUyaWb2e-bezm084/edit#slide=id.p1) for [Firebase Test Lab](https://firebase.google.com/docs/test-lab/).
 
@@ -458,17 +458,17 @@ flank:
 
 Download Flank from GitHub releases.
 
-Stable. Get the latest [stable version number](https://github.com/TestArmada/flank/releases/latest) and replace the `XXX` with the version number.
+Stable. Get the latest [stable version number](https://github.com/Flank/flank/releases/latest) and replace the `XXX` with the version number.
 
 ```
-wget --quiet https://github.com/TestArmada/flank/releases/download/vXXX/flank.jar -O ./flank.jar
+wget --quiet https://github.com/Flank/flank/releases/download/vXXX/flank.jar -O ./flank.jar
 java -jar ./flank.jar android run
 ```
 
 Snapshot (published after every commit)
 
 ```
-wget --quiet https://github.com/TestArmada/flank/releases/download/flank_snapshot/flank.jar -O ./flank.jar
+wget --quiet https://github.com/Flank/flank/releases/download/flank_snapshot/flank.jar -O ./flank.jar
 java -jar ./flank.jar android run
 ```
 
@@ -556,28 +556,28 @@ dependencies {
 
 ### FAQ
 
-> Access Not Configured. Cloud Tool Results API has not been used in project 764086051850 before or it is disabled.
+1) > Access Not Configured. Cloud Tool Results API has not been used in project 764086051850 before or it is disabled.
 
-This error means authentication hasn't been setup properly. See `Authenticate with a service account` in this readme.
+    This error means authentication hasn't been setup properly. See `Authenticate with a service account` in this readme.
 
-> How do I use Flank without typing long commands?
+2)  > How do I use Flank without typing long commands?
 
-Add Flank's [bash helper folder](https://github.com/TestArmada/flank/blob/master/test_runner/bash/) to your $PATH environment variable. This will allow you to call the shell scripts in that helper folder from anywhere.
+    Add Flank's [bash helper folder](https://github.com/Flank/flank/blob/master/test_runner/bash/) to your $PATH environment variable. This will allow you to call the shell scripts in that helper folder from anywhere.
 
-With the [flank](https://github.com/TestArmada/flank/blob/master/test_runner/bash/flank) shell script, you can use `flank` instead of `java -jar flank.jar`. Examples:
+    With the [flank](https://github.com/Flank/flank/blob/master/test_runner/bash/flank) shell script, you can use `flank` instead of `java -jar flank.jar`. Examples:
 
-- `flank android run`
-- `flank ios run`
+    - `flank android run`
+    - `flank ios run`
 
-With the [update_flank.sh](https://github.com/TestArmada/flank/blob/master/test_runner/bash/update_flank.sh) shell script, you can rebuild `flank.jar`.
+    With the [update_flank.sh](https://github.com/Flank/flank/blob/master/test_runner/bash/update_flank.sh) shell script, you can rebuild `flank.jar`.
 
-> Symbol is declared in module 'java.xml' which does not export package 'com.sun.org.apache.xerces.internal.dom'
+3)  > Symbol is declared in module 'java.xml' which does not export package 'com.sun.org.apache.xerces.internal.dom'
 
-Make sure you're using JDK 8 to compile Flank.
+    Make sure you're using JDK 8 to compile Flank.
 
-> Test run failed to complete. Expected 786 tests, received 660
+4)  > Test run failed to complete. Expected 786 tests, received 660
 
-Try setting `use-orchestrator: false`. Parameterized tests [are not compatible with orchestrator](https://stackoverflow.com/questions/48735268/unable-to-run-parameterized-tests-with-android-test-orchestrator). Flank uses [orchestrator by default on Android.](https://developer.android.com/training/testing/junit-runner)
+    Try setting `use-orchestrator: false`. Parameterized tests [are not compatible with orchestrator](https://stackoverflow.com/questions/48735268/unable-to-run-parameterized-tests-with-android-test-orchestrator). Flank uses [orchestrator by default on Android.](https://developer.android.com/training/testing/junit-runner)
 
 # Resources
 

contributing.md

@@ -15,7 +15,7 @@ When opening the project in IntelliJ IDEA, select the "Import from Existing Sour
 
 ## Debugging Flank Commands
 
-There is a [`Debug.kt`](https://github.com/Flank/flank/blob/master/test_runner/src/test/kotlin/Debug.kt#L8) which is your entry point. You can start a debug session here and set breakpoints wherever you need them.
+There is a [`Debug.kt`](https://github.com/Flank/flank/blob/master/test_runner/src/test/kotlin/Debug.kt#L8) which is your entry point. You can start a debug session here and set breakpoints wherever you need them. TIP: while debugging use `gs://...` links to avoid uploading apk/zip files
 
 Note: The breakpoints will only hit for the actual command being run. For example, for `firebase test android run`, the debugger will directly enter [`AndroidRunCommand`](https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt).
 

docs/readme.md

@@ -6,10 +6,10 @@ Rewrite of Flank in Kotlin
 
 - APIs are used for all Google Cloud interactions
 - Firebase Test Lab transparently retries VMs 3x
-  - Infrastructure Failures may lead to [4 hours or more of wait times](https://github.com/TestArmada/flank/issues/108) as a result, retrying VMs on failure isn't super helpful.
+  - Infrastructure Failures may lead to [4 hours or more of wait times](https://github.com/Flank/flank/issues/108) as a result, retrying VMs on failure isn't super helpful.
   - VM timeout applies only once the VM has booted. Hours spent waiting for the VM to boot aren't included in the wait time.
 - Test failures are best retried using [a retry JUnit rule](https://github.com/instructure/instructure-android/blob/80b0c5e7256317c223d4d3ed6f3b918df31c2548/espresso/src/main/java/com/instructure/espresso/ScreenshotTestRule.java#L38) combined with Android Test Orchestrator and an [app reset rule](https://github.com/instructure/instructure-android/blob/80b0c5e7256317c223d4d3ed6f3b918df31c2548/teacher/app/src/androidTest/java/com/instructure/teacher/ui/utils/TeacherActivityTestRule.java#L39)
-  - On device retry is free since we don't need to spin up a new VM. 
+  - On device retry is free since we don't need to spin up a new VM.
   - Each VM created is another opportunity for FTL to error. Even when VMs boot correctly, it's at least a 5m wait time.
 
 ## Client libraries

faq.md

@@ -22,4 +22,4 @@ flank:
 
 To always shard each test on a new device, omit `shard-time`.
 
-[1]: https://github.com/TestArmada/flank/blob/6d128ce949247ea3b5066677a220b93b028ae77f/test_runner/src/main/kotlin/ftl/shard/Shard.kt#L92
+[1]: https://github.com/Flank/flank/blob/6d128ce949247ea3b5066677a220b93b028ae77f/test_runner/src/main/kotlin/ftl/shard/Shard.kt#L92