device-farm-pro-docs/mkdocs-pro.yml at main · AppiumTestDistribution/device-farm-pro-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
site_name: Device Farm Pro
repo_url: https://github.com/AppiumTestDistribution/device-farm
repo_name: AppiumTestDistribution/device-farm
site_url: https://pro.devicefarm.io/
edit_uri: edit/main/docs
site_description: Production-grade distributed mobile device testing platform for iOS and Android
docs_dir: docs-pro
site_dir: site-pro

theme:
  name: material
  logo: assets/images/DeviceFarm-Logo.jpg
  favicon: assets/images/appium-logo.png
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow
  font:
    text: Inter
    code: Roboto Mono
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - meta
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - docs/overrides/.icons/
  - pymdownx.tasklist:
      custom_checkbox: true
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true

extra_css:
  - assets/stylesheets/extra.css

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AppiumTestDistribution/device-farm
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/atddevs/orchestrator
  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: Thanks for your feedback!

plugins:
  - search
  - glightbox

nav:
  - Home:
    - index.md
    - quick-start.md
    - architecture.md
    - why-device-farm.md

  - Installation:
    - installation/index.md
    - installation/npm.md
    - installation/docker.md
    - installation/kubernetes.md

  - Configuration:
    - configuration/index.md
    - configuration/hub.md
    - configuration/node.md
    - configuration/environment-variables.md

  - Usage:
    - usage/index.md
    - usage/capabilities.md
    - usage/session-lifecycle.md
    - usage/device-selection.md
    - usage/client-examples.md

  - iOS Setup:
    - ios/index.md
    - ios/prerequisites.md
    - ios/wda-signing.md
    - ios/real-devices.md
    - ios/simulators.md

  - Advanced Features:
    - advanced/index.md
    - advanced/storage-adapters.md
    - advanced/device-reconciliation.md
    - advanced/idle-detection.md
    - advanced/browser-disconnect.md
    - advanced/video-recording.md
    - advanced/log-streaming.md

  - Deployment:
    - deployment/index.md
    - deployment/production.md
    - deployment/https.md
    - deployment/monitoring.md
    - deployment/scaling.md

  - Troubleshooting:
    - troubleshooting/index.md
    - troubleshooting/common-issues.md
    - troubleshooting/node-offline.md
    - troubleshooting/device-detection.md
    - troubleshooting/session-failures.md

  - API Reference:
    - api/index.md
    - api/webdriver-endpoints.md
    - api/websocket-events.md
    - api/rest-api.md