Phase 1 Documentation Release

docs/antora.yml

@@ -5,7 +5,7 @@ nav:
   - modules/get-started/nav.adoc
   - modules/release-notes/nav.adoc
   - modules/support/nav.adoc
-  - modules/organizations/nav.adoc
+  - modules/organization-and-profile/nav.adoc
   - modules/get-started/nav.adoc
   - modules/apps/nav.adoc
   - modules/manual-testing/nav.adoc

docs/modules/ROOT/pages/index.adoc

@@ -0,0 +1,4 @@
+= Get started
+:navtitle: Get started
+
+This.

docs/modules/ROOT/partials/supported-filetypes-for-app-uploads.adoc

@@ -0,0 +1,14 @@
+Only the following filetypes are supported for Android and iOS apps:
+
+[cols="^1,^1,5"]
+|===
+|OS |Filetype |Description
+
+|Android |`.apk` | A standard package containing your app and related resources.
+
+|Android |`.aab` |An Android App Bundle (AAB) containing your app and related resources that defers `.apk` generation and signing to Google.
+
+|iOS |`.ipa` | A standard package containing your app and related resources.
+
+|iOS |`.zip` | A standard `.zip` file containing a compressed version of your iOS app and related resources.
+|===

docs/modules/apps/nav.adoc

@@ -1,3 +1 @@
-* xref:index.adoc[]
-** xref:install-an-app.adoc[]
-** xref:manage-your-library.adoc[]
+* xref:index.adoc[]

docs/modules/apps/pages/app-metadata.adoc

@@ -0,0 +1,50 @@
+= App metadata
+:navtitle: App metadata
+
+You can use the app library to display an app's metadata, like latest version, supported CPUs, last updated date, and more.
+
+[#_metadata]
+== Metadata
+
+Display metadata by selecting the version dropdown beneath an app.
+
+=== Name
+
+The name of your app within Kobiton. This doesn't need to match the public name, so xref:manage-an-app.adoc#_rename_an_app[choose any name] that works for you and your team.
+
+=== Version
+
+There can be xref:manage-an-app.adoc#_upload_an_app_version[multiple versions] for each app. For example, `1.0.2` and `1.1.0`. Use this field to identify the app version.
+
+=== Latest
+
+There can be xref:manage-an-app.adoc#_upload_an_app_version[multiple versions] for each app. For example, `1.0.2` and `1.1.0`. Use this field to identify whether the version you're looking at is the latest version.
+
+=== App ID
+
+The unique identifier assigned to each app. For example, `com.kobiton.appname`.
+
+=== Bundle version
+
+Your app's bundle version. For example, `1.2.5`.
+
+=== Bundle ID
+
+The unique identifier Apple and Google use to identify your app. For example, `com.kobiton.appname`.
+
+=== Minimum OS version
+
+The earliest operating system (OS) version compatible with your app. For example, `iOS 11.0` or `Android 15`.
+
+=== Supported CPU architectures
+
+The different mobile CPUs compatible with your app. For example, `arm 64` or `x86`.
+
+=== Updated
+
+The date your app was last updated.For example, `May 15, 2023 10:55:35`.
+
+[#_uploaded_by]
+=== Uploaded by
+
+The user who uploaded this version of the app.For example, `alex-lee`.

docs/modules/apps/pages/manage-an-app.adoc

@@ -0,0 +1,45 @@
+= Manage an app
+:navtitle: Manage an app
+
+Learn how to manage an app after you xref:manage-your-library.adoc#_upload_an_app[add it to your library]. You can rename apps, upload new versions, limit app access, and more.
+
+== Options
+
+[#_supported_filetypes]
+=== Supported filetypes
+
+include::ROOT:partial$supported-filetypes-for-app-uploads.adoc[]
+
+[#_rename_an_app]
+=== Rename an app
+
+You can rename an app to change how it appears in search results. First, search for your app using its xref:app-metadata.adoc#_metadata[metadata].
+
+When you're ready, select *Rename Application* and enter a new name to rename your app.
+
+[#_upload_an_app_version]
+=== Upload an app version
+
+You can upload a new app by opening your app library and selecting the *+ icon*.Choose your xref:_supported_filetypes[app file] from your computer and select *Upload*.
+
+We'll let you know when its finished uploading, so you can start xref:manage-an-app.adoc[managing your app].
+
+[#_remove_an_app_version]
+=== Remove an app version
+
+First, search for your app using its xref:app-metadata.adoc#_metadata[metadata].
+
+Confirm you want to remove this version rather than the xref:manage-your-library.adoc#_remove_an_app[full app].When you're ready, select *Remove App*.
+
+=== Download an app
+
+include::apps:partial$download-an-app.adoc[]
+
+=== Limit access
+
+You can limit who can access your app. First, search for your app using its xref:app-metadata.adoc#_metadata[metadata].
+
+When you're ready, select the *globe icon* then choose *Allow access to my team(s)* or *Allow only me to access*.
+
+[NOTE]
+You can find which team(s) you're a part of on your xref:organization-and-profile:your-teams/manage-your-teams.adoc[organization's team page].

docs/modules/apps/pages/manage-your-library.adoc

@@ -1,16 +1,29 @@
-= App repository
-:navtitle: App repository
+= Manage your library
+:navtitle: Manage your library
 
-Intro.
+Learn how to manage your app library so you and your team can easily access the apps you use most. After an app is uploaded, you can rename it, upload new versions, limit access, and xref:manage-an-app.adoc[more].
 
-[#_add_an_app_to_the_app_repository]
-== Add an app to the app repository
+== Options
 
-. Open the https://portal.kobiton.com/login[Kobiton portal].
-. Select *Apps*.
-. Add a new app to the app repository or a new version to an existing app:
-* *New app:* Select *Click to add a new app*.
-* *New version:* Select an app, then select *Click to add a new version*.
+[#_supported_filetypes]
+=== Supported filetypes
 
-. Upload an `.apk`, `.ipa`, `.zip`, or `.aab` file from your local device.
-. You'll receive a notification when your upload is complete.
+include::ROOT:partial$supported-filetypes-for-app-uploads.adoc[]
+
+[#_upload_an_app]
+=== Upload an app
+
+You can upload a new app by opening your app library and selecting the *+ icon*.Choose your xref:_supported_filetypes[app file] from your computer and select *Upload*.
+
+We'll let you know when its finished uploading, so you can start xref:manage-an-app.adoc[managing your app].
+
+[#_remove_an_app]
+=== Remove an app
+
+First, search for your app using its xref:app-metadata.adoc#_metadata[metadata].
+
+Confirm you want to remove the full app rather than a xref:manage-an-app.adoc#_remove_an_app_version[specific version]. When you're ready, select *Remove App*.
+
+=== Download an app
+
+include::apps:partial$download-an-app.adoc[]

docs/modules/apps/pages/use-our-rest-api.adoc

@@ -0,0 +1,74 @@
+= Use our REST API
+:navtitle: Use our REST API
+
+You can use our link:https://api.kobiton.com/docs/[REST API] to upload apps to your app library.
+
+== Before you start
+
+include::ROOT:partial$supported-filetypes-for-app-uploads.adoc[]
+
+== Generate an upload URL
+
+First, call `/apps/uploadUrl` to generate the URL you'll need to upload apps to our private S3 bucket on Amazon Web Services (AWS).
+
+[source,]
+----
+# You can also use wget
+curl -X POST https://api.kobiton.com/v1/apps/uploadUrl \
+  -H 'Authorization: Basic dGVzdHVzZXI6MTIzZWQtMTIzZmFjLTkxMzdkY2E=' \
+  -H 'Content-Type: application/json' \
+  -H 'Accept: application/json' \
+  -d '{
+  "filename" :  "${app-filename}", # Replace with ...
+  "appId" :  1
+}'
+----
+
+Here's an example of a successful response:
+
+[source,]
+----
+{
+"appPath" :  "users/1/apps/app‐prod‐debug‐237824a0‐302c‐9bfd‐ff417c89610a.apk",
+"url" :  "https://kobiton-us.s3.amazonaws.com/users/1/apps/app‐f417c89610a.apk?AWSAccessKeyId=AKINQ57IQCo
+"
+}
+----
+
+Keep a copy of `appPath`. You'll need it later to xref:_initiate_upload[initiate your upload].
+
+== Send app to S3
+
+Next, make a `PUT` request using the `url` you generated to send your app to our private S3 bucket.
+
+[source,]
+----
+# You can also use wget
+curl
+  -T ${filePath} \  # Replace with ...
+  -H "Content-Type: application/octet-stream" \
+  -H "x-amz-tagging: unsaved=true" \
+  -X PUT ${presignedUrl} # Replace with ...
+----
+
+A successful `PUT` request will return a `200` status.
+
+[#_initiate_upload]
+== Initiate upload
+
+Finally, make a `POST` request to initiate your upload to the app library in Kobiton.
+
+[source,]
+----
+# You can also use wget
+curl -X POST https://api.kobiton.com/v1/apps \
+  -H 'Authorization: Basic dGVzdHVzZXI6MTIzZWQtMTIzZmFjLTkxMzdkY2E=' \
+  -H 'Content-Type: application/json' \
+  -H 'Accept: application/json' \
+  -d '{
+  "filename" :  "${app-filename}", # Replace with ...
+  "appPath" :  "${uploadUrl-call}" # Replace with ...
+}'
+----
+
+If your request was successful, `POST` will return `200`. The API will then extract your app's metadata, preform security checks, and upload the app to your library.

docs/modules/apps/partials/download-an-app.adoc

@@ -0,0 +1,3 @@
+You can download an app from your library to install on a test device xref:devices:install-an-app.adoc[before] or xref:manual-testing:install-an-app-during-a-session.adoc[during] a session. First, search for your app using its xref:app-metadata.adoc#_metadata[metadata].
+
+When you're ready, select *Download* to download the current version.To download a previous version, select your app first, then download a version.

docs/modules/automation-testing/nav.adoc

@@ -1,2 +1 @@
-* xref:automation-testing:index.adoc[]
-** xref:automation-testing:your-first-automation-session.adoc[]
+* xref:index.adoc[]

docs/modules/debugging/nav.adoc

@@ -1,2 +1 @@
-* xref:debugging:index.adoc[]
-** xref:debugging:your-first-virtualusb-session.adoc[]
+* xref:index.adoc[]

docs/modules/devices/nav.adoc

@@ -1,2 +1 @@
-* xref:devices:index.adoc[]
-** xref:devices:allow-a-device-on-your-network.adoc[]
+* xref:index.adoc[]

docs/modules/devices/pages/find-a-device.adoc

@@ -1,15 +1,15 @@
 = Find a device
 :navtitle: Find a device
 
-Learn how to find a device by filtering your search results with views, statuses, custom columns, and more. Once you've found one, you can start xref:manage-your-devices.adoc[managing the device].
+Learn how to find a device by filtering your search results with views, statuses, custom columns, and more. Once you've found one, you can start xref:manage-a-device.adoc[managing the device].
 
 == Filter your search results
 
 First, you'll want to filter your search results.Open your device list, select a xref:#_views[view], then choose a xref:#_device_categories[device category].
 
 Select *List View*, *Edit Column*, and choose xref:#_custom_columns[up to nine columns].
 
-Once you've found a device, select the *vertical ellipses* to start xref:manage-your-devices.adoc[managing your device].
+Once you've found a device, select the *vertical ellipses* to start xref:manage-a-device.adoc[managing your device].
 
 [#_search_filters]
 == Search filters

docs/modules/devices/pages/install-an-app.adoc

@@ -0,0 +1,16 @@
+= Install an app
+:navtitle: Install an app
+
+Learn how to permanently install an app on a device, so can start testing as soon as you start a new session. If you only need it on this device temporarily, try xref:manual-testing:install-an-app-during-a-session.adoc[installing during a session].
+
+== Before you start
+
+You'll need to add your app xref:apps:manage-your-library.adoc[to the library]. Once an app is uploaded,you can install it on a device.
+
+== Install your app
+
+First you'll need to xref:find-a-device.adoc[find a device]. When you're ready, open the xref:manage-a-device.adoc#_open_the_device_overview[device overview] and select *Apps*.
+
+Search using the app name, or manually scroll through the list of apps. Keep in mind, only the [latest version] can be installed on an app.
+
+Select *Install* to permanently install the app to this device.

docs/modules/devices/pages/manage-your-devices.adoc → docs/modules/devices/pages/manage-a-device.adoc

@@ -1,20 +1,21 @@
-= Customize your device
-:navtitle: Customize your device
+= Manage a device
+:navtitle: Manage a device
 
-Learn how to customize a device by changing its name, installing apps, selecting configurations, and more.
+Learn how to manage a device by changing its name, installing apps, selecting configurations, and more.
 
 [NOTE]
 Only available for private and local devices.
 
+[#_open_the_device_overview]
 == Open the device overview
 
-After you xref:find-a-device.adoc[find a device], select the *vertical ellipses* to open the device overview. Here, you'll manage the device.
+After you xref:find-a-device.adoc[find a device], select the *vertical ellipses* to open the device overview.Here, you'll manage the device.
 
-== Make changes
+== Customization options
 
 === Rename the device
 
-Rename your device to change how it appears in xref:find-a-device.adoc#_search_filters[search results]. Select the device name, then enter a new name for the device. If you want to apply this name to all similar devices, select the checkbox.
+Rename your device to change how it appears in xref:find-a-device.adoc#_search_filters[search results].Select the device name, then enter a new name for the device.If you want to apply this name to all similar devices, select the checkbox.
 
 When you're finished, save your changes.
 
@@ -32,7 +33,7 @@ Your new tag will save automatically.
 
 === Enable network payload capture
 
-After you xref:organizations:your-organization/about-network-payload-capture.adoc[set up network payload capture], enable this feature by selecting *Use Configuration* and choosing the configuration you created.
+After you xref:organization-and-profile:your-organization/about-network-payload-capture.adoc[set up network payload capture], enable this feature by selecting *Use Configuration* and choosing the configuration you created.
 
 === Retain the device
 
@@ -42,4 +43,4 @@ Select *Retain* to reserve this device and prevent another tester from using it.
 
 === Require a passcode
 
-If your organization xref:organizations:your-organization/set-up-device-passcodes.adoc[set up device passcodes], select *Passcode Feature Enforced* to require a passcode for this device. Now a passcode will be required to use this device in a test session.
+If your organization xref:organization-and-profile:your-organization/set-up-device-passcodes.adoc[set up device passcodes], select *Passcode Feature Enforced* to require a passcode for this device. Now a passcode will be required to use this device in a test session.

docs/modules/glossary/nav.adoc

@@ -0,0 +1 @@
+* xref:index.adoc[]

docs/modules/integrations/nav.adoc

@@ -1,2 +1 @@
-* xref:integrations:index.adoc[]
-** xref:integrations:test-page.adoc[]
+* xref:index.adoc[]

docs/modules/integrations/pages/biometric-authentication/add-our-library-to-your-android-app.adoc

@@ -3,7 +3,7 @@
 
 Learn how to add our biometric authentication library to your Android xref:biometric-authentication/add-our-library-to-your-ios-app.adoc[or iOS] app, so you can test biometric authentication during your manual and automated test sessions. Our library lets you …, which we believe is xref:biometric-authentication/about-our-library.adoc[a better way to test biometrics].
 
-After you add our library, rebuild your `.apk` and upload it to the xref:apps:manage-your-library.adoc[app repository].
+After you add our library, rebuild your `.apk` and upload it to the xref:apps:manage-an-app.adoc[app repository].
 
 == Before you start