Skip to content

Commit 39c3bee

Browse files
authored
docs: improve migration guide, android testing and component testing articles (#31)
* docs: advise to install latest 4 version instead of 4.0.0 * docs: fix broken list markdown * docs: add brief info about testing android apps
1 parent 64bc132 commit 39c3bee

File tree

6 files changed

+60
-10
lines changed

6 files changed

+60
-10
lines changed

docs/guides/android-testing.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import Admonition from "@theme/Admonition";
2+
3+
# Тестирование Android Приложений
4+
5+
<Admonition type="warning">
6+
Статья на данный момент содержит базовые сведения и будет улучшена в [testplane#1002](https://github.com/gemini-testing/testplane/issues/1002).
7+
8+
При возникновении вопросов обращайтесь в [discussions](https://github.com/gemini-testing/testplane/discussions) на GitHub.
9+
10+
</Admonition>
11+
12+
## Обзор
13+
14+
Testplane использует WebdriverIO для общения с браузерами и устройствами, поэтому из коробки есть поддержка тестирования нативных Android приложений на реальных устройствах или эмуляторах с помощью [Appium](https://appium.io/docs/en/latest/).
15+
16+
## Быстрый старт
17+
18+
- [Шаблонный проект](https://github.com/webdriverio/appium-boilerplate) для запуска тестов на Android/iOS с помощью WebdriverIO и Appium
19+
- [Документация](https://webdriver.io/docs/api/appium) по взаимодействию с Appium с помощью WebdriverIO
20+
- [Документация Appium](https://appium.io/docs/en/2.0/intro/)

docs/guides/component-testing.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,16 @@ function Component() {
139139
## Временные ограничения
140140

141141
<Admonition type="warning">
142-
* поддерживаются только компоненты, написанные на React в файлах .jsx и .tsx. Возможность
142+
- поддерживаются только компоненты, написанные на React в файлах .jsx и .tsx. Возможность
143143
написания тестов в файлах .js будет реализована в ближайшем будущем. Мы также планируем
144-
поддержку фреймворка Vue; * нет доступа к currentTest из it, beforeEach и afterEach. Это будет
145-
добавлено в ближайшем будущем; * плагин [@testplane/global-hook][testplane-global-hook] в
144+
поддержку фреймворка Vue;
145+
146+
- нет доступа к currentTest из it, beforeEach и afterEach. Это будет
147+
добавлено в ближайшем будущем;
148+
149+
- плагин [@testplane/global-hook][testplane-global-hook] в
146150
настоящее время временно не поддерживается.
151+
147152
</Admonition>
148153

149154
## Дополнительные возможности

docs/migrations/how-to-upgrade-hermione-to-4.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,14 +306,14 @@ module.exports = {
306306

307307
А именно:
308308

309-
- обновите версию hermione до hermione@4.0.0;
309+
- обновите версию hermione до hermione@4;
310310
- установите плагин [hermione-wdio-migrator][hermione-wdio-migrator] для плавной миграции команд;
311311
- установите пакет [hermione-codemod][hermione-codemod] для конвертации существующих тестов в новый синтаксис;
312312

313313
Всё это вы можете сделать одной командой:
314314

315315
```shell
316-
npm install -D hermione@4.0.0 hermione-wdio-migrator hermione-codemod --save-exact
316+
npm install -D hermione@4 hermione-wdio-migrator hermione-codemod --save-exact
317317
```
318318

319319
Версии всех плагинов hermione (например, [html-reporter][html-reporter]) также необходимо обновить до последних версий, т. к. часть из них может работать неправильно с новой версией hermione.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import Admonition from "@theme/Admonition";
2+
3+
# Testing Android Applications
4+
5+
<Admonition type="warning">
6+
The article currently contains basic information and will be improved in [testplane#1002](https://github.com/gemini-testing/testplane/issues/1002).
7+
8+
If you have any questions, please refer to the [discussions](https://github.com/gemini-testing/testplane/discussions) on GitHub.
9+
10+
</Admonition>
11+
12+
## Overview
13+
14+
Testplane uses WebdriverIO to communicate with browsers and devices, so out of the box, it supports testing native Android applications on real devices or emulators using [Appium](https://appium.io/docs/en/latest/).
15+
16+
## Quick Start
17+
18+
- [Template Project](https://github.com/webdriverio/appium-boilerplate) for running tests on Android/iOS using WebdriverIO and Appium
19+
- [Documentation](https://webdriver.io/docs/api/appium) for interacting with Appium using WebdriverIO
20+
- [Appium Documentation](https://appium.io/docs/en/2.0/intro/)

i18n/en/docusaurus-plugin-content-docs/current/guides/component-testing.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,11 +143,16 @@ A fully working examples can be found [here][testplane-examples-component-testin
143143
## Temporary restrictions
144144

145145
<Admonition type="warning">
146-
* only components written in React in files `.jsx` and `.tsx` are supported. Ability to write
146+
- only components written in React in files `.jsx` and `.tsx` are supported. Ability to write
147147
tests in `.js` files will be implemented soon. We will also support the Vue framework in the
148-
near future; * there is no access to `currentTest` from `it`, `beforeEach` and `afterEach`. It
149-
will appear in the near future; * the [@testplane/global-hook][testplane-global-hook] plugin is
148+
near future;
149+
150+
- there is no access to `currentTest` from `it`, `beforeEach` and `afterEach`. It
151+
will appear in the near future;
152+
153+
- the [@testplane/global-hook][testplane-global-hook] plugin is
150154
temporarily not supported.
155+
151156
</Admonition>
152157

153158
## Additional features

i18n/en/docusaurus-plugin-content-docs/current/migrations/how-to-upgrade-hermione-to-4.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,14 +306,14 @@ We upgraded _webdriverio_ by three major versions at once, so simply updating th
306306
307307
Specifically:
308308
309-
- Update hermione to hermione@4.0.0.
309+
- Update hermione to hermione@4.
310310
- Install the [hermione-wdio-migrator][hermione-wdio-migrator] plugin for smooth command migration.
311311
- Install the [hermione-codemod][hermione-codemod] package to convert existing tests to the new syntax.
312312
313313
You can do all this with one command:
314314
315315
```shell
316-
npm install -D hermione@4.0.0 hermione-wdio-migrator hermione-codemod --save-exact
316+
npm install -D hermione@4 hermione-wdio-migrator hermione-codemod --save-exact
317317
```
318318
319319
The versions of all hermione plugins (e.g., [html-reporter][html-reporter]) also need to be updated to the latest versions, as some may not work correctly with the new hermione version.

0 commit comments

Comments
 (0)