Describe the task

Migrate Create custom gesture document from zendesk: https://support.kobiton.com/hc/en-us/articles/4423231453453-Create-custom-gesture

Sub-tasks (optional)

Timeline

• Date assigned: Jan 13 2023
• Complete by:

Feature description

Antora has built-in admonitions. Change our repository's admonitions to the new styles.

Examples (optional)

Issue description

Create a 404 page for when end-users go to a broken link using the docs.kobiton.com domain. This is the current experience:

How to guide:

• Add a 404 Error Page

Issue description

The link for "Edit this page" needs to be connected to the Kobiton Docs GitHub repository: https://github.com/kobiton/docs.

The way this should be implemented is that when a user selects Edit this page:

It would open the page in GitHub:

Feature description

Allow repository contributors to create manual URL redirects as-needed, so when files or directories are renamed, customer-facing URLs aren't broken.

Possible implementation (optional)

• N/A

Examples (optional)

Here's an example in Microsoft's open-source documentation.

Issue description

Currently docs.kobiton.com doesn't have an icon in the browser tab. One needs to be added.

Additional information (optional)

Screenshots:

What to do:

• Checkout this PR: #190
• Move screenshots of Android devices from https://support.kobiton.com/hc/en-us/articles/14838599224845-Prepare-Android-device-for-hosting-on-Kobiton to the correct places inside docs/modules/device-lab-management/pages/android-devices/prepare-android-device.adoc. Ensure image size is under 100KB.

We need to decouple Zendesk help docs (help center) from the request form and reviewing tickets and ensure redirects work properly.

Here is a reference: https://support.zendesk.com/hc/en-us/articles/4408884098074

Things to consider:

• We need to figure out how that will flow from Antora docs site. And, we should recreate a home page on Antora.
  Can the Antora site take over support.kobiton.com? (if not - we need to make sure there's a link to the new Antora help docs from the request form site)
• How much do we need to get look-and-feel to "match" between them?
• Assume we'll still offer a direct link from Portal to submit a support ticket - which would go to this new site. Plus, we need a prominent place to do it from the new help docs

Issue description

Re-add the internal nav for doc pages on the right side of the page. Looks like it may have been removed here:

#84

Additional information (optional)

Screenshots:

Describe the task

Restructure documentation to live under a single module.

Timeline

• Date assigned: December 5, 2022
• Complete by:

Feature description

iOS Voiceover is no longer working due to changes made by Apple.

We need to remove this page - devices/local-devices/configure-ios-voiceover - from the navigation and if someone tries to go directly to it with a bookmark - redirect them to the docs home page.

Issue description

Currently, when using partial:: to import content from a different module, all xref: and image: tags are broken because they were all written relative to the original module. All of these paths need to have the original module added to the path.

Example

Before
File 1:

• Location: /docs/modules/integrations/biometric-authentication/add-our-library-to-your-android-app.adoc
• Reference: xref:biometric-authentication/add-our-library-to-your-android-app.adoc[Text]

File 2:

• Location: /docs/modules/automation-testing/about-automation-testing.adoc
• Reference: xref:about-automation-testing.adoc[Text]

After:
File 1:

• Location: /docs/modules/integrations/biometric-authentication/add-our-library-to-your-android-app.adoc
• Reference: xref:integrations:biometric-authentication/add-our-library-to-your-android-app.adoc[Text]

File 2:

• Location: /docs/modules/automation-testing/about-automation-testing.adoc
• Reference: xref:automation-testing:about-automation-testing.adoc[Text]

Tasks:

• Refer to the existing structure of our Integration section (CircleCI example): https://docs.kobiton.com/integrations/circleci/
• Add 2 pages, each page introduce briefly about the feature of the Github Action of Kobiton and link to the marketplace for how to use them.
  • Upload an app to Kobiton: https://github.com/marketplace/actions/kobiton-upload-mobile-app
  • Run Appium Script on Kobiton devices: https://github.com/marketplace/actions/kobiton-execute-appium-test

It is highly recommended that you try to follow the docs yourself and verify if the steps in the guides are still up to date. If you run into any issue, please contact me.

Issue description

Fix color for 'Support' dropdown. Set the color to match the site header or be darker. See Antora site for an example.

Additional information (optional)

Screenshots:

Tasks:

• Create a new branch from main
• Add 2 new pages
  • "Add the image injection SDK to your iOS app" under Apps/Enable image injection
  • "Create an image injection script" under Automation testing/Scripting
    Migrate the content of this file
    Kobiton SDK User Guide.docx
    , which includes instructions for both of the above, into the appropriate place.

Tasks:

• Check out a new branch
• Create a new page under Integrations/Jira. Fill in the content of this pdf
  KOBITON-Enable Jira Data Center integration-130624-084410.pdf.
• Revise the style and wordings.
• Make sure images is not over 100KB in size.

Tasks:

• Checkout a new branch
• Update the file device-lab-management/android-devices/prepare-android-device page.
• Add a section called "Turn off Google Play Protect (optional)"
• Add the below steps to that section:
  

Is your feature request related to a problem? Please describe.

The ability for certain content to only display for cloud vs. stand-alone customers.

Describe the solution you'd like

Use Antora/AsciiDoc to create a conditional statement that displays content based on the following:

• Stand alone?
• If yes: X
• If no: Y

This will also need accompanying contributing documentation.

Describe alternatives you've considered

N/A

The link icon for in-page headers is broken/missing.

Feature description

Add in-page tabbing so you can have steps for windows and mac on the same page without taking up too much screen space or needing to add two separate articles to the left-side nav bar.

Ways to implement (optional)

• AsciiDoc Tabs extention

Examples (optional)

• Microsoft Azure Docs

Issue description

Remove kobiton-docs/, index, _attchments/, and .html from all URLs on docs.kobiton.com. If removing index is not possible thats fine, but lets at least remove kobiton-docs/ and .html as a minimum.

Example 1:
Before: https://docs.kobiton.com/kobiton-docs/profile/index.html
After: https://docs.kobiton.com/profile

Example 2:
Before: https://docs.kobiton.com/kobiton-docs/profile/manage-your-profile.html
After: https://docs.kobiton.com/profile/manage-your-profile

Example 3:
Before: https://docs.kobiton.com/kobiton-docs/devices/_attachments/kobiton-network-payload-capture-certificate-1.3.crt
After: https://docs.kobiton.com/devices/kobiton-network-payload-capture-certificate-1.3.crt

Additional information (optional)

Screenshots:

Summary

• Create a new main navigation section under Reporting in left hand nav: Device Lab Management
• Add the following pages under Device Lab Management in this order:
  • Hardware requirements for deviceConnect
  • Retrieve deviceConnect logs
  • Restart deviceConnect services

See Docs Tracker for link to new pages: https://docs.google.com/spreadsheets/d/1YW39fMopX4w_yBN4GhW7TPczTJ79VhDIHRUyP7AGJLU/edit?usp=sharing

Acceptance Criteria:
All content of the docs is accurately created.
All images should be less than 100KB in size. Use TinyPNG to compress the image if needed.
The migrated docs satisfy requirements from the Contributing guidelines where applicable.

Tasks:

• Checkout a new branch

• Migrate these 2 docs to a new section under Integration called Applitools Eyes. Make sure to add the necessary navigation in the nav.adoc files.

KOBITON-Enable Applitools Eyes integration-250624-090642.pdf
KOBITON-Run Appium script with Applitools Eyes SDK-250624-090916.pdf
Note: In the pdf the code snippet may be cut off, see below for the full code snippets:

// Set desired capabilities.
DesiredCapabilities capabilities = new DesiredCapabilities();

  capabilities.setCapability("platformName", "Android");
  // Use either deviceName or udid to select the device
  // capabilities.setCapability("deviceName", "Pixel 7");
  capabilities.setCapability("udid", "f40d06b2-daa4-4b62-896e-c0e675135ecd ");
  capabilities.setCapability("platformVersion", "*");
  capabilities.setCapability("app", "https://applitoolsnmlresources.z19.web.core.windows.net/TestApps/app-debug.apk");
  capabilities.setCapability("browserName", "");
  capabilities.setCapability("automationName", "UiAutomator2");
  // Use the kobiton:runtime capability below if you want to launch a Basic Appium 2 session
  // capabilities.setCapability("kobiton:runtime", "appium");

// Open the app.
WebDriver driver = new AndroidDriver(new URL("https://[username]:[api_key]@api.kobiton.com/wd/hub"), capabilities);

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.remote.DesiredCapabilities;
import io.appium.java_client.android.AndroidDriver;
import java.net.URL;
import com.applitools.eyes.appium.Eyes;



public class Appium_native_java {

    public static void main(String[] args) throws Exception {

        // Set desired capabilities.
        DesiredCapabilities capabilities = new DesiredCapabilities();

          capabilities.setCapability("platformName", "Android");
          // Use either deviceName or udid to select the device
          // capabilities.setCapability("deviceName", "Pixel 7");
          capabilities.setCapability("udid", "f40d06b2-daa4-4b62-896e-c0e675135ecd ");
          capabilities.setCapability("platformVersion", "*");
          capabilities.setCapability("app", "https://applitoolsnmlresources.z19.web.core.windows.net/TestApps/app-debug.apk");
          capabilities.setCapability("browserName", "");
          capabilities.setCapability("automationName", "UiAutomator2");
          // Use the kobiton:runtime capability below if you want to launch a Basic Appium 2 session
          // capabilities.setCapability("kobiton:runtime", "appium");

        // Open the app.
        WebDriver driver = new AndroidDriver(new URL("https://johndoe:[email protected]/wd/hub"), capabilities);

        // Initialize the eyes SDK and set your private API key.
        Eyes eyes = new Eyes();
        eyes.setApiKey("ak9FuNVsyEsDi62buhydjLi7HASD5435fgdgdorEHXY110");

        eyes.setForceFullPageScreenshot(true);

        try {

            // Start the test.
            eyes.open(driver, "Contacts!", "My first Appium native Java test!");

            // Visual validation.
            eyes.checkWindow("Contact list!");

            // End the test.
            eyes.close();

        } finally {

            // Close the app.
            driver.quit();

            // If the test was aborted before eyes.close was called, ends the test as aborted.
            eyes.abortIfNotClosed();

        }

    }

}

• Review the style of the docs to make sure it is consistent with the style of our docs site.
• Run the docs through Grammarly or ChatGPT to correct grammar mistakes and typos.
• Make sure images are under 100KB in size.

Issue description

Change "Getting started" to "Get started" on the landing page tiles.

Find and replace the following words in the "Release Notes" section:

• Beta > beta
• data driven > data-driven
• Data driven > Data-driven
• Data Driven > Data-Driven
• one time password > one-time password
• One time password > One-time password
• One Time > One-Time
• role based access control > Role-Based Access Control
• role-based access control > Role-Based Access Control
• Org. > Organization
• org. > organization
• Re-visit > Revisit
• re-visit > revisit
• Re-run > rerun
• re-run > rerun
• api's > APIs
• API's > APIs
• ksl > IQS
• KSL > IQS

Description

Migrate the attached pdf file about bypassing Apple Pay document to docs.kobiton.com.
KOBITON-Bypass double-click side button to confirm payment on iOS devices-220424-085059.pdf

Acceptance Criteria

• The docs is migrated to a suitable location based on the structure of docs.kobiton.com. Suggestion: This doc should be under Devices -> Local or Private Device section, in a new article called Bypass double-click side button to confirm payment on iOS devices.
• If it seems appropriate to split the original doc into multiple articles, please do so.
• All content of the docs is accurately migrated.
• All images should be less than 100KB in size. Use TinyPNG to compress the image if needed.
• The migrated docs satisfy requirements from the Contributing guidelines where applicable.

Tasks:

• Check out the PR: #190
• Add a new page under docs/modules/device-lab-management/pages/android-devices/. Fill in the new page with this content:
  KOBITON-Add Android devices-280524-074230.pdf
• At the start of the pdf file there is a link to the prepare an Android device page. Link that to our new page at docs/modules/device-lab-management/pages/android-devices/prepare-android-device.adoc

Verification:

• change top-level navigation from "Debugging" to "virtualUSB"
• ensure redirects from "Debugging" to "virtualUSB" are setup in case someone has "Debugging" linked
• ensure all internal references to "Debugging" are changed

Remove the 3.24 versioning showing. It is confusing and will be difficult to maintain

Feature description

Create a product glossary and update all docs to use official terminology. Run a find-and-replace to update related docs.

Possible implementation (optional)

Define these words:

• N/A

Replace these words:

• Beta > beta
• data driven > data-driven
• Data driven > Data-driven
• Data Driven > Data-Driven
• one time password > one-time password
• One time password > One-time password
• One Time > One-Time
• role based access control > Role-Based Access Control
• role-based access control > Role-Based Access Control
• Org. > Organization
• org. > organization
• Re-visit > Revisit
• re-visit > revisit
• Re-run > rerun
• re-run > rerun
• api's > APIs
• API's > APIs
• ksl > IQS
• KSL > IQS

Related issues

• Includes content from #16.

Examples

• N/A

Tasks:

• Check out the PR: #190
• Add a new page under docs/modules/device-lab-management/pages/ios-devices/. Fill in the new page with this content:
  KOBITON-Add iOS devices-300524-091231.pdf
• At the start of the pdf file there is a link to the prepare an iOS device page. Link that to our new page at docs/modules/device-lab-management/pages/android-devices/prepare-ios-device.adoc
• If there are links that points to current page on docs.kobiton.com, use xref to reference accordingly.

Describe the task

Migrate Create and manage webhooks from zendesk: https://support.kobiton.com/hc/en-us/articles/12076478365581-Create-and-manage-webhooks

Sub-tasks (optional)

Timeline

• Date assigned: Jan 17 2023
• Complete by:

Summary

• Migrate this article to docs.kobiton.com: https://support.kobiton.com/hc/en-us/articles/12076478365581-Create-and-manage-webhooks

Acceptance Criteria:

• The docs is migrated to a suitable location based on the structure of docs.kobiton.com. Suggestion: This doc should be under Integrations in a new category called Webhook.
• All content of the docs is accurately migrated.
• All images should be less than 100KB in size. Use TinyPNG to compress the image if needed.
• The migrated docs satisfy requirements from the Contributing guidelines where applicable.

Issue description

Remove widget modules from search results. Currently users can search:

• API reference / api-reference module
• Reference resources / widget module

Additional information (optional)

Screenshots:

Issue description

Run yarn outdated to review outdated and unneeded project dependencies found in package.json and yarn.lock.

Tasks:

• Replace [email protected]. Impacts @antora/file-publisher and @antora/ui-loader in @antora/site-generator.
• Upgrade @mermaid-js/mermaid-cli.
• Remove [email protected]. @mermaid-js/mermaid-cli can be used instead.
• Either upgrade or remove @sntke/antora-mermaid-extension, depending if same functionality is built in to @mermaid-js/mermaid-cli.
• Either upgrade or remove mermaid, depending if same functionality is built in to @mermaid-js/mermaid-cli.

To add description

Issue description

Center the copyright element in the CSS. This needs to be updated in the following files:

• ui-bundle-docs/css/site.css
• ui-bundle-widget/css/site.css

Additional information (optional)

Screenshots:

Describe the task

Create an include/admonition for which devices are supported for biometrics. Use this page to get started:

https://support.kobiton.com/hc/en-us/articles/10367516557965-Biometrics-authentication#prerequisites-0-0

Timeline

• Date assigned: 03-16-23
• Complete by: N/A

Issue description

Remove the version dropdown from bottom of the table of contents on docs.kobiton.com. This should only be removed in:

• ui-bundle-docs/css/site.css
• ui-bundle-widget/css/site.css

The antora playbooks should not be changed.

Additional information (optional)

Screenshots:

Describe the bug

Links in PR Template are broken

To Reproduce

Steps to reproduce the behavior:

1. Go to any PR.
2. Click on Kobiton Style Guide or approved format.
3. See error.

Expected behavior

Should like to proper places.

Issue description

The current description displayed in search engine results is just the TOC. Update this to an actual description.

*search result 4 below:

Issue description

Disable auto word breaks, instead move word to new line.

Reproduce the issue

For example, "Default" in the line "... By default, finger..." is broken into two separate lines with a hyphen. Instead create new line.

Screenshots:

Migrate the Zendesk - Manual Testing to AsciiDoc.

Feature description

Add title link to in-page nav so you can jump directly to top of page from the nav.

Current docs: https://docs.kobiton.com/apps/app-metadata
Goal: https://docs.wagtail.org/en/stable/getting_started/integrating_into_django.html#

Ways to implement (optional)

• N/A

Examples (optional)

• N/A

Issue description

The font between the Kobiton product and docs need to be consistent.