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.

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

Fixing all Antora errors (except placeholders) #125

Merged
merged 2 commits into from
Jul 20, 2023
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
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Learn how to auto-generate an Appium script from a manual session so you can sta

== Before you start

Appium scripts are automatically generated after every _successful_ manual session. Before you start, check if your session xref:scriptless-automation:remediation-options.adoc[requires remediation].
Appium scripts are automatically generated after every _successful_ manual session. Before you start, check if your session xref:scriptless-automation:remediation/about-remediation.adoc[requires remediation].

[#_export_your_script]
== Export your script
Expand All @@ -14,7 +14,7 @@ After your manual session, search for your session, open the session overview, a

image:automation-testing:export-appium-script-context.png[width=1200, alt="The automated test case for the selected session."]

Next, select the *Export Appium Script* icon. If you don't see an icon, check if your session xref:scriptless-automation:remediation-options.adoc[requires remediation].
Next, select the *Export Appium Script* icon. If you don't see an icon, check if your session xref:scriptless-automation:remediation/about-remediation.adoc[requires remediation].

image:automation-testing:export-appium-script-closeup.png[width=750, alt="Session overview tabs, including Automated Test Case, Jira Integration, Rerun, and the Appium Export icon."]

Expand All @@ -38,4 +38,4 @@ root
----

[NOTE]
You can also use auto-generate Appium scripts for xref:scriptless-automation:export-appium-scripts.adoc[Scriptless sessions].
You can also use auto-generate Appium scripts for xref:scriptless-automation:index.adoc[Scriptless sessions].
2 changes: 1 addition & 1 deletion docs/modules/debugging/pages/search-for-a-device.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use xref:_filters[filters] to search for a device.

=== Search bar

To filter the list by one or more types of xref:debugging:device-metadata.adoc[device metadata], enter metadata into the *search bar*.
To filter the list by one or more types of xref:devices:device-metadata.adoc[device metadata], enter metadata into the *search bar*.

image:debugging:search-bar-closeup.png[width=1000,alt="A closeup on the search bar"]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Configure iOS VoiceOver
:navtitle: Configure iOS VoiceOver

Learn how to configure iOS VoiceOver so you can run xref:manual-testing:ios-voiceover-commands.adoc[iOS VoiceOver commands] to test your app's screen reader compatibility during your test session.
Learn how to configure iOS VoiceOver so you can run xref:manual-testing:local-devices/ios-voiceover-commands.adoc[iOS VoiceOver commands] to test your app's screen reader compatibility during your test session.

== Before you start

Expand Down Expand Up @@ -40,4 +40,4 @@ Turn on *VoiceOver*, then select *Audio* and turn on *Send to HDMI*.
[NOTE]
You will not use an HDMI connection during testing, however this setting is still required for full VoiceOver functionality.

Now you can run xref:manual-testing:ios-voiceover-commands.adoc[iOS VoiceOver commands] during a manual test session.
Now you can run xref:manual-testing:local-devices/ios-voiceover-commands.adoc[iOS VoiceOver commands] during a manual test session.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= About network payload capture
:navtitle: About network payload capture

Network payload captures lets you and your team capture network payload data during xref:manual-testing:enable-network-payload-capture.adoc[manual sessions] and xref:automation-testing:enable-network-payload-capture.adoc[automation sessions]. After a session using network payload capture, you can view the data in the xref:session-analytics:about-the-session-explorer.adoc[Session Explorer].
Network payload captures lets you and your team capture network payload data during xref:manual-testing:local-devices/enable-network-payload-capture.adoc[manual sessions] and xref:automation-testing:enable-network-payload-capture.adoc[automation sessions]. After a session using network payload capture, you can view the data in the xref:session-analytics:about-the-session-explorer.adoc[Session Explorer].

image:$NEW-IMAGE$[width=, alt=""]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Configure Android device for network payload capture
:navtitle: Configure Android device

Learn how to configure network payload capture for Android devices so you and your team can use network payload capture during a xref:manual-testing:enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].
Learn how to configure network payload capture for Android devices so you and your team can use network payload capture during a xref:manual-testing:local-devices/enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].

[NOTE]
You'll need to configure each Android device you want to use for network playload capture.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Configure ios device for network payload capture
:navtitle: Configure iOS device

Learn how to configure an iOS device for network payload capture so you and your team can use network payload capture during a xref:manual-testing:enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].
Learn how to configure an iOS device for network payload capture so you and your team can use network payload capture during a xref:manual-testing:local-devices/enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].

[NOTE]
You'll need to configure each iOS device you want to use for network playload capture.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Configure local server for network payload capture
:navtitle: Configure local server

Learn how to configure your local Kobiton server so you and your team can use network payload capture during a xref:manual-testing:enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].
Learn how to configure your local Kobiton server so you and your team can use network payload capture during a xref:manual-testing:local-devices/enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].

[NOTE]
Network paylaod capture can only be configured by an admin with access to the *deviceConnect* Mac mini server.
Expand Down Expand Up @@ -68,4 +68,4 @@ Once logged in, enter the following command to exit the SSH session.
exit
----

Now, once you configure an Android or iOS, you and your team can use network payload capture during a xref:manual-testing:enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].
Now, once you configure an Android or iOS, you and your team can use network payload capture during a xref:manual-testing:local-devices/enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].
2 changes: 1 addition & 1 deletion docs/modules/devices/pages/manage-devices.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To remove a tag, select the *x* icon.

== Enable network payload capture

Once xref:manual-testing:enable-network-payload-capture.adoc[network payload capture] is enabled, select *Use Configuration* and choose a configuration.
Once xref:manual-testing:local-devices/enable-network-payload-capture.adoc[network payload capture] is enabled, select *Use Configuration* and choose a configuration.

image:devices:config-section-context.png[width=500,alt=" A context of Use Configuration section - Managing Device modal"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ In the device UDID directory, create a file named `config` and add the following
}
----

When you're finished, save your changes. Now you can use network payload capture during a xref:manual-testing:enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].
When you're finished, save your changes. Now you can use network payload capture during a xref:manual-testing:local-devices/enable-network-payload-capture.adoc[manual session] or xref:automation-testing:enable-network-payload-capture.adoc[automation session].
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ This Release Pipeline demo will go over:

An Artifact will be added the APK file. You can learn more about Artifacts on the link:https://docs.microsoft.com/azure/devops/pipelines/release/artifacts?view=azure-devops[Azure DevOps Documentation]. There are many ways to create an artifact, but in this sample we will create a simple artifact containing the test APK file.

. On the left sidebar, click **Repos > Files** image:./guide-media/01GWEJYNQN51FHSMRWWDYZKS5N[]
. On the left sidebar, click **Repos > Files**
+
image:$OLD-IMAGE$[width="", alt=""]

. On the **Clone to your computer** section:
.. Click the **Generate Git Credentials** button to display **User Name** and **Password** that will be used in a later step.
.. Copy the URL below: +
Expand All @@ -20,25 +23,68 @@ https://AZURE_ORG_NAME@dev.azure.com/AZURE_ORG_NAME/AZURE_PROJECT_NAME/_git/AZUR
----

.. On your local machine, open Terminal and enter: `git clone GIT_URL`
.. Replace GIT_URL with the URL above, depending on your project setup. If prompted during the cloning process, use the **Username** and **Password** from step 2. image:./guide-media/01GWDZ1R1SHXG4XKVASXERNHRQ[]
.. Replace GIT_URL with the URL above, depending on your project setup. If prompted during the cloning process, use the **Username** and **Password** from step 2.
+
image:$OLD-IMAGE$[width="", alt=""]

.. In your local machine, copy the APK file to the cloned repository. Then `cd` to the repository and type this line in your terminal: `git add . && git commit -m "Upload apk" && git push`
.. We copied the **ApiDemos-debug. apk** file in the /Downloads folder in to the Git repository. You can access and download the sample app link:https://appium.github.io/appium/assets/ApiDemos-debug.apk[here]. image:./guide-media/01GWEFXBT5YNYE8H3JB5BE4FX2[]
.. **Back to your Azure DevOps web page**, confirm that the uploaded file is listed on your Azure DevOps Project. image:./guide-media/01GWEQSTTMVJ3C4GJJPSGN9EZZ[]
.. Create a Release Pipeline. On your Azure DevOps Project, click on the **Release Pipeline** page. image:./guide-media/01GWEMM38WNV4SJD287KD4GR67[]
.. We create a new Release pipeline, but an existing pipeline can be reused. Click the **New pipeline** button to create a new release pipeline. image:./guide-media/01GWE77Q2KDKS6HJTE8WRN1AH1[]
.. We copied the **ApiDemos-debug. apk** file in the /Downloads folder in to the Git repository. You can access and download the sample app link:https://appium.github.io/appium/assets/ApiDemos-debug.apk[here].
+
image:$OLD-IMAGE$[width="", alt=""]

.. **Back to your Azure DevOps web page**, confirm that the uploaded file is listed on your Azure DevOps Project.
+
image:$OLD-IMAGE$[width="", alt=""]

.. Create a Release Pipeline. On your Azure DevOps Project, click on the **Release Pipeline** page.
+
image:$OLD-IMAGE$[width="", alt=""]

.. We create a new Release pipeline, but an existing pipeline can be reused. Click the **New pipeline** button to create a new release pipeline.
+
image:$OLD-IMAGE$[width="", alt=""]

.. On the right sidebar, click **Empty job** to create an empty Release Stage.
.. To add an Artifact, click on the **Add an artifact** button. image:./guide-media/01GWEBXH98YS3VK672F6QMZ6NH[] image:./guide-media/01GWEMKFJMA96MYW9XNPB5C0FC[]
.. To add an Artifact, click **+Add an artifact**. image:./guide-media/01GWEYQDX56DHN9AE7Y74R4NRS[]
.. To add an Artifact, click on the **Add an artifact** button.
+
image:$OLD-IMAGE$[width="", alt=""]
image:$OLD-IMAGE$[width="", alt=""]

.. To add an Artifact, click **+Add an artifact**.
+
image:$OLD-IMAGE$[width="", alt=""]

.. Select **Azure Repository** and enter the required information, and then click **Add**.
.. In the **Artifact** dialog, do the following:
$DESCRIPTION$ Select **Build** from the **Source type** dropdown menu.
$DESCRIPTION$ For **Project** and **Source**, select the necessary project.
$DESCRIPTION$ Choose **Default version** to **Latest**. Then click **Add**. image:./guide-media/01GWECN1ATZ6YZM4S6K2BRSE69[]
.. The pipeline now includes the newly created artifact. image:./guide-media/01GWEW4BWM0P1JDPKKM1V9K3QX[]
.. To add a task to the stage, click on **1 job, 0 task**. image:./guide-media/01GWEVPEENM2B9B6ZB6XYNRYJV[]
.. You can add a **Kobiton task** to execute a test on a Kobiton device. Click on **+Add a task to agent job** to add a task to the stage. image:./guide-media/01GWEP6H4SVE21J1HFW1BR3HZZ[]
.. Click on the Kobiton icon to add a Kobiton task. image:./guide-media/01GWEN94QZ6MSJNBXN7GP54NRF[]
.. Enter the required information to set up the task. image:./guide-media/01GWELRW7XYJGRMQVN2TMMVXJV[]
... Select **Build** from the **Source type** dropdown menu.
... For **Project** and **Source**, select the necessary project.
... Choose **Default version** to **Latest**.
... Then click **Add**.
+
image:$OLD-IMAGE$[width="", alt=""]

.. The pipeline now includes the newly created artifact.
+
image:$OLD-IMAGE$[width="", alt=""]

.. To add a task to the stage, click on **1 job, 0 task**.
+
image:$OLD-IMAGE$[width="", alt=""]
+
image:$OLD-IMAGE$[width="", alt=""]

.. You can add a **Kobiton task** to execute a test on a Kobiton device. Click on **+Add a task to agent job** to add a task to the stage.
+
image:$OLD-IMAGE$[width="", alt=""]

.. Click on the Kobiton icon to add a Kobiton task.
+
image:$OLD-IMAGE$[width="", alt=""]

.. Enter the required information to set up the task.
+
image:$OLD-IMAGE$[width="", alt=""]

.. You have successfully created the task. You can also create a task to upload a new version of the app from APK file.

The next two sections will guide you on how to use these **Kobiton Release Tasks**.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ After adding the Kobiton Automation Test Executor task to your pipeline, you'll
* Git repository branch: Git branch that will execute automation test script.
* Git repository SSH key: The SSH Key to access a private Git repository. In this document, we will use Kobiton's public sample repository and will leave this field empty.

image:./guide-media/01GWEMKVWEC6VK1XH404WSHJ4R[alt="step1.png"]
image:$OLD-IMAGE$[width="", alt=""]

== Modify Desired Capabilities

Expand Down Expand Up @@ -45,7 +45,7 @@ image:./guide-media/01GWEMKVWEC6VK1XH404WSHJ4R[alt="step1.png"]
* *Log Type:* Users can pick a type of log to be printed. *Combined* means the *output logs* and *error logs* will be printed in chronological order. The Separated option allows you to choose one of the 2 types of logs. It is recommended to log your test case result with appropriate log type. For example, in Java you can use `System.err.println` to print test case errors, this will be in the *error logs* while `System.out.println` will return texts in *output logs*.
* *Terminate release pipeline on failed job:* If checked, once the execution job status is *FAILED*, an error will be returned and the whole release is terminated *(All the following release tasks below this task will be skipped)*.

image:./guide-media/01GWE55DADJDTP17S9A6N2YJG8[step7.png]
image:$OLD-IMAGE$[width="", alt=""]

== Execute the release

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,18 @@ For Kobiton Executor Server credentials, please link:https://kobiton.com/contact
== Install extension

. To access the Kobiton Azure DevOps Extension, click link:https://marketplace.visualstudio.com/items?itemName=Kobiton.Kobiton[here].
image:./guide-media/01GWDZDMN2NZRY9HXS58W7CKME[mceclip0.png]
+
image:$OLD-IMAGE$[width="", alt=""]

. To install the extension, follow the instructions on this link:https://docs.microsoft.com/azure/devops/marketplace/install-extension?view=azure-devops&tabs=browser[guide.]
. Log into the Kobiton Executor Server.

== Kobiton API Credentials

* You will need your Kobiton *Username* and *Password (API Key)* to interact with Kobiton REST API using our Azure DevOps plugin.
* To get your Kobiton *Username* and *API Key*, please follow instructions at *IV*. Configure Test Script for Kobiton section on link:https://kobiton.com/blog/tutorial/parallel-testing-selenium-webdriver/[our blog].
image:./guide-media/01GWEBXTZ05AYNHXTAP2HASGFY[mceclip1.png]
+
image:$OLD-IMAGE$[width="", alt=""]

== Git repository contains your automation test script + SSH Key

Expand Down
8 changes: 4 additions & 4 deletions docs/modules/integrations/pages/bitrise/bitrise.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ This step is already launched and available in the Bitrise Step library (see lin

To use it, go to link:https://devcenter.bitrise.io/en/steps-and-workflows/adding-steps-to-a-workflow.html#adding-steps-to-a-workflow[Workflow editor], click *+* and search for Kobiton:

image:/guide-media/01GWEGNMV8FJ1NACDT3HEK78DZ[]
image:$OLD-IMAGE$[width="", alt=""]

Click on the step to add it to your workflow - the added step will look like this:

image:/guide-media/01GWESRBKJD9WF0JQJ68HT8X76[]
image:$OLD-IMAGE$[width="", alt=""]

Review and input your app info as well as your Kobiton credentials (to get your Kobiton Username and API Key, login to the Kobiton portal and go to link:https://portal.kobiton.com/settings/keys[link:https://portal.kobiton.com/settings/keys]).

Expand All @@ -40,11 +40,11 @@ This step will execute an automated test script on the Kobiton service (see link

You can search for this step in the Workflow editor:

image:/guide-media/01GWDZEAPKC6104PS1JSHRW8RE[]
image:$OLD-IMAGE$[width="", alt=""]

Once added, the step will look like this:

image:/guide-media/01GWESRCDEE60P13DVBG9NNYS0[]
image:$OLD-IMAGE$[width="", alt=""]

To use this step, you will need the following information:

Expand Down
12 changes: 8 additions & 4 deletions docs/modules/integrations/pages/buildkite/buildkite.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,15 @@ steps:
| API key to access Kobiton API, for example `2c8n41e4-b30d-4f19-ba63-6596016c9e58`. To get your Kobiton API Key, please follow instructions at _IV. Configure Test Script for Kobiton_ section on link:https://kobiton.com/blog/tutorial/parallel-testing-selenium-webdriver/[our blog]
|===

For example: This will upload a new app version to app ID = 294808 and this app is private. image:./guide-media/01GWDZECF8TQXCKCKGFPTQDM3D[]
For example: This will upload a new app version to app ID = 294808 and this app is private.

Once you're done adding the plugin to your pipeline, click on "Save and Build", then click "Create Build" to proceed. image:./guide-media/01GWE1DA6J088P949DYNJ3S8YQ[]
image:$OLD-IMAGE$[width="", alt=""]

image:./guide-media/01GWEFXWJN3WFR3SPABHBNV5NH[]
Once you're done adding the plugin to your pipeline, click on "Save and Build", then click "Create Build" to proceed.

image:$OLD-IMAGE$[width="", alt=""]

image:$OLD-IMAGE$[width="", alt=""]

(Optional) Once the pipeline completes running, you can go to Kobiton App Repo to double check your new application/new application version.

Expand Down Expand Up @@ -131,6 +135,6 @@ If it’s set to “false”, the release pipeline will continue to the next ste

Example:

image:./guide-media/01GWEGNP2MJAAWS9VXARSZQMHG[image-20220509-140135.png]
image:$OLD-IMAGE$[width="", alt=""]

Once you’re done adding the plugin to your pipeline, select “Save and Build”, then click “Create Build” to proceed.
Loading
Loading