Skip to content

Commit

Permalink
Merge pull request #805 from austyh/docs/cloud
Browse files Browse the repository at this point in the history
docs(cloud): Added Marathon Cloud overview
  • Loading branch information
Malinskiy committed Jun 18, 2023
2 parents c9f441c + 96f2f31 commit 05c6cb1
Show file tree
Hide file tree
Showing 6 changed files with 7,068 additions and 7,050 deletions.
40 changes: 40 additions & 0 deletions docs/docs/cloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "Overview"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Marathon Cloud is a cloud testing infrastructure built on top of the Marathon test runner.
It automatically provisions virtual devices to accommodate your tests within 15 minutes.
The test execution is then delegated to Marathon test runner, which handles tasks such as batching,
sorting, preventive retries, and post-factum retries.
This ensures an even distribution of tests across the provisioned devices.


## What you'll need

To utilize Marathon Cloud, please ensure you have the following:
- Marathon Cloud account ([Sign up or Sign here](https://cloud.marathonlabs.io/signup))
- API Key: You can create an API Key by following the [link](https://cloud.marathonlabs.io/tokens) provided.
- CLI or CI/CD plugin: Make sure you have the [Command Line Interface (CLI)](https://github.com/MarathonLabs/marathon-cloud-cli) or the appropriate Continuous Integration/Continuous Deployment (CI/CD) plugin installed.
- Application with tests for iOS or Android

## Application requirements

### iOS

Marathon Cloud supports tests written with XCTest and XCUITest frameworks.
Both the application and the tests must be built for the ARM architecture.
When dealing with iOS applications and tests, please compress them into ZIP archives.
For instance, if your project is named "SampleApp," navigate to Product -> Show Build Folder in Finder.
In the opened Finder window, you'll find the required folders/applications for testing: "SampleApp.app" for the application and "SampleAPPUITests-Runner.app" for the Testing Application.

### Android

Marathon Cloud supports tests written with UIAutomator, Cucumber, Espresso, and Kaspresso frameworks.
You will need APK files for both the application and the tests.

## Installation

Please look at CLI [Readme on Github](https://github.com/MarathonLabs/marathon-cloud-cli).
6 changes: 3 additions & 3 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,15 @@ const config = {
]
},
gtag: {
trackingID: 'G-7RE7PPY2QW',
anonymizeIP: false,
trackingID: 'G-7RE7PPY2QW',
anonymizeIP: false,
},
},
],
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({

colorMode: {
Expand Down
12 changes: 6 additions & 6 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "2.2.0",
"@docusaurus/plugin-google-gtag": "^2.2.0",
"@docusaurus/plugin-ideal-image": "^2.2.0",
"@docusaurus/preset-classic": "2.2.0",
"@docusaurus/theme-mermaid": "^2.2.0",
"@docusaurus/core": "^2.4.1",
"@docusaurus/plugin-google-gtag": "^2.4.1",
"@docusaurus/plugin-ideal-image": "^2.4.1",
"@docusaurus/preset-classic": "^2.4.1",
"@docusaurus/theme-mermaid": "^2.4.1",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
"docusaurus-plugin-module-alias": "^0.0.2",
Expand All @@ -34,7 +34,7 @@
"sass": "^1.57.1"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^2.2.0",
"@docusaurus/module-type-aliases": "^2.4.1",
"@tsconfig/docusaurus": "^1.0.6",
"typescript": "^4.9.4"
},
Expand Down
132 changes: 70 additions & 62 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
@@ -1,75 +1,83 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
Create as many sidebars as you want.
*/

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
docs: [
docs: [
{
type: 'category',
label: 'Getting Started',
collapsed: false,
items: [
'index',
'intro/overview',
'intro/install',
{
type: 'category',
label: 'Getting Started',
collapsed: false,
items: [
'index',
'intro/overview',
'intro/install',
{
type: 'category',
label: 'Configuration',
collapsed: true,
items: [
'intro/configure',
'configuration/filtering',
'configuration/analytics',
'configuration/pooling',
'configuration/sharding',
'configuration/sorting',
'configuration/batching',
'configuration/flakiness',
'configuration/retries',
'configuration/dynamic-configuration',
]
},
'intro/execute',
'intro/reports',
'intro/faq',
'intro/vision',
'intro/contribute',
'intro/special-thanks',
],
type: 'category',
label: 'Configuration',
collapsed: true,
items: [
'intro/configure',
'configuration/filtering',
'configuration/analytics',
'configuration/pooling',
'configuration/sharding',
'configuration/sorting',
'configuration/batching',
'configuration/flakiness',
'configuration/retries',
'configuration/dynamic-configuration',
]
},
{
type: 'category',
label: 'Android',
collapsed: false,
items: [
'android',
'android/install',
'android/configure',
'android/examples',
],
},
{
type: 'category',
label: 'iOS',
collapsed: false,
items: [
'ios',
'ios/workers',
'ios/configure',
'ios/examples',
],
},
],
'intro/execute',
'intro/reports',
'intro/faq',
'intro/vision',
'intro/contribute',
'intro/special-thanks',
],
},
{
type: 'category',
label: 'Android',
collapsed: false,
items: [
'android',
'android/install',
'android/configure',
'android/examples',
],
},
{
type: 'category',
label: 'iOS',
collapsed: false,
items: [
'ios',
'ios/workers',
'ios/configure',
'ios/examples',
],
},
{
type: 'category',
label: 'Cloud',
collapsed: false,
items: [
'cloud'
]
}
],
};

module.exports = sidebars;
1 change: 1 addition & 0 deletions docs/src/theme/NavbarItem/ComponentTypes.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import NavbarIconLink from "./NavbarIconLink";
import NavbarSeparator from "./NavbarSeparator";
import NavbarCta from "./NavbarCta";


// Related to https://github.com/facebook/docusaurus/issues/7227
const ComponentTypes = {
default: DefaultNavbarItem,
Expand Down
Loading

0 comments on commit 05c6cb1

Please sign in to comment.