Skip to content

Commit e2c3ed3

Browse files
committed
Update the documentation
1 parent be6485f commit e2c3ed3

File tree

7 files changed

+32
-30
lines changed

7 files changed

+32
-30
lines changed

examples/behave_bdd/ReadMe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- SeleniumBase Docs -->
22

3-
## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 🐝 Behave test runner for SeleniumBase 🐝
3+
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) 🐝 Behave test runner for SeleniumBase 🐝
44

55
🐝 (Utilizes the [Behave BDD Python library](https://github.com/behave/behave). For more info, see the [Behave tutorial](https://behave.readthedocs.io/en/stable/tutorial.html) and read about [Behave's Gherkin model](https://behave.readthedocs.io/en/stable/gherkin.html).)
66

@@ -76,7 +76,7 @@ Took 0m1.672s
7676

7777
🐝⚪ With the Dashboard enabled, you'll get one of these:
7878

79-
<img src="https://seleniumbase.io/cdn/img/sb_behave_dashboard.png" title="SeleniumBase" width="600">
79+
<img src="https://seleniumbase.github.io/cdn/img/sb_behave_dashboard.png" title="SeleniumBase" width="600">
8080

8181
### 🐝 Behave-Gherkin files:
8282

@@ -219,7 +219,7 @@ sbase behave-gui
219219
* Starting the SeleniumBase Behave Commander GUI App...
220220
```
221221
222-
<img src="https://seleniumbase.io/cdn/img/sbase_behave_gui_wide_5.png" title="SeleniumBase" width="600">
222+
<img src="https://seleniumbase.github.io/cdn/img/sbase_behave_gui_wide_5.png" title="SeleniumBase" width="600">
223223
224224
🐝🎖️ You can customize the tests that show up there:
225225

examples/capabilities/ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- SeleniumBase Docs -->
22

3-
<h3><img src="https://seleniumbase.io/img/green_logo.png" title="SeleniumBase" width="32" /> Using Desired Capabilities</h3>
3+
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> Using Desired Capabilities</h3>
44

55
You can specify browser capabilities when running SeleniumBase tests on a remote Selenium Grid server such as <a href="https://www.browserstack.com/automate/capabilities" target="_blank">BrowserStack</a>, <a href="https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/" target="_blank">Sauce Labs</a>, or another.
66

examples/master_qa/ReadMe.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!-- SeleniumBase Docs -->
22

3-
![](https://seleniumbase.io/cdn/img/masterqa_logo.png "MasterQA")
3+
![](https://seleniumbase.github.io/cdn/img/masterqa_logo.png "MasterQA")
44

5-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> MasterQA combines automation with manual verification steps.</h3>
5+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> MasterQA combines automation with manual verification steps.</h3>
66

7-
![](https://seleniumbase.io/cdn/gif/masterqa6.gif "MasterQA")
7+
![](https://seleniumbase.github.io/cdn/gif/masterqa6.gif "MasterQA")
88

99
Here's code from [basic_masterqa_test_0.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/basic_masterqa_test_0.py):
1010

@@ -27,11 +27,11 @@ After each automation checkpoint, a pop-up window will ask the user questions fo
2727

2828
When the test run completes, as seen from [this longer example](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test_1.py), you'll reach the results page that appears after answering all the verification questions. (Failed verifications generate links to screenshots and log files.)
2929

30-
![](https://seleniumbase.io/cdn/img/mqa_hybrid.png "MasterQA")
30+
![](https://seleniumbase.github.io/cdn/img/mqa_hybrid.png "MasterQA")
3131

3232
You may have noticed the ``Incomplete Test Runs`` row on the results page. If the value for that is not zero, it means that one of the automated steps failed. This could happen if you tell your script to perform an action on an element that doesn't exist. Now that we're mixing automation with manual QA, it's good to tell apart the failures from each. The results_table CSV file contains a spreadsheet with the details of each failure (if any) for both manual and automated steps.
3333

34-
#### How to run the example tests from scratch:
34+
**How to run the example tests from scratch:**
3535

3636
```bash
3737
git clone https://github.com/seleniumbase/SeleniumBase.git
@@ -44,7 +44,7 @@ pytest masterqa_test_1.py
4444

4545
At the end of your test run, you'll receive a report with results, screenshots, and log files. Close the Results Page window when you're done.
4646

47-
### Check out [masterqa_test_1.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test_1.py) to learn how to write your own MasterQA tests:
47+
**Check out [masterqa_test_1.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test_1.py) to learn how to write your own MasterQA tests:**
4848

4949
You'll notice that tests are written the same way as regular [SeleniumBase](https://seleniumbase.com) tests, with the key difference being a different import: ``from seleniumbase import MasterQA`` rather than ``from seleniumbase import BaseCase``. Now your Python test class will import ``MasterQA`` instead of ``BaseCase``.
5050

mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,12 @@ plugins:
7474
- SECURITY.md
7575
- examples/case_summary.md
7676
- help_docs/chinese.md
77+
- help_docs/chart_maker.md
7778
- help_docs/mysql_installation.md
7879
- integrations/katalon/ReadMe.md
7980
- help_docs/verify_webdriver.md
8081
- help_docs/webdriver_installation.md
82+
- seleniumbase/masterqa/ReadMe.md
8183
- seleniumbase/utilities/selenium_ide/ReadMe.md
8284
- seleniumbase/examples/chart_maker/ReadMe.md
8385
- minify:
@@ -107,7 +109,7 @@ nav:
107109
- 🎦 Demo Mode: help_docs/demo_mode.md
108110
- 🚎 Tour Maker: examples/tour_examples/ReadMe.md
109111
- 🛂 Dialog Boxes: examples/dialog_boxes/ReadMe.md
110-
- 📶 Chart Maker: help_docs/chart_maker.md
112+
- 📶 Chart Maker: examples/chart_maker/ReadMe.md
111113
- 🎞️ Presentation Maker: examples/presenter/ReadMe.md
112114
- Integrations:
113115
- 📱 Mobile Testing: help_docs/mobile_testing.md
@@ -116,7 +118,6 @@ nav:
116118
- 🖼️ Visual Testing: examples/visual_testing/ReadMe.md
117119
- 🕵️ The HTML Inspector: help_docs/html_inspector.md
118120
- 🌐 Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
119-
- 📶 HighCharts: examples/chart_maker/ReadMe.md
120121
- 🛂 MasterQA: examples/master_qa/ReadMe.md
121122
- 🤖 Azure Pipelines: integrations/azure/azure_pipelines/ReadMe.md
122123
- 🤖 Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
@@ -156,7 +157,6 @@ nav:
156157
- 👤 Shadow DOM Support: help_docs/shadow_dom.md
157158
- 👥 macOS Hidden Files: help_docs/hidden_files_info.md
158159
- 🗄️ MySQL Instructions: help_docs/mysql_installation.md
159-
- 🛂 Master QA Hybrid Mode: seleniumbase/masterqa/ReadMe.md
160160
- 📃 Desired Capabilities: help_docs/desired_capabilities.md
161161
- 📜 Useful grep commands: help_docs/useful_grep_commands.md
162162
- ⚙️ WebDriver Installation: help_docs/webdriver_installation.md

mkdocs_build/prepare.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -178,10 +178,12 @@ def main(*args, **kwargs):
178178
if "<!-- SeleniumBase Docs -->" in line:
179179
changed = True
180180
line = (
181-
'<h2><img src="https://seleniumbase.io/img/sb_icon.png" '
182-
'title="SeleniumBase" width="20" /> SeleniumBase Docs '
183-
'<img src="https://seleniumbase.io/img/sb_icon.png" '
184-
'title="SeleniumBase" width="20" /></h2>'
181+
'<h2><img '
182+
'src="https://seleniumbase.github.io/img/logo3b.png" '
183+
'title="SeleniumBase" width="24" /> SeleniumBase Docs '
184+
'<img '
185+
'src="https://seleniumbase.github.io/img/logo3b.png" '
186+
'title="SeleniumBase" width="24" /></h2>'
185187
)
186188
seleniumbase_lines.append(line)
187189
if changed:

seleniumbase/masterqa/ReadMe.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<!-- SeleniumBase Docs -->
22

3-
![](https://seleniumbase.io/cdn/img/masterqa_logo.png "MasterQA")
3+
![](https://seleniumbase.github.io/cdn/img/masterqa_logo.png "MasterQA")
44

5-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> MasterQA combines automation with manual verification steps.</h3>
5+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> MasterQA combines automation with manual verification steps.</h3>
66

7-
![](https://seleniumbase.io/cdn/gif/masterqa6.gif "MasterQA")
7+
![](https://seleniumbase.github.io/cdn/gif/masterqa6.gif "MasterQA")
88

99
Here's code from [basic_masterqa_test_0.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/basic_masterqa_test_0.py):
1010

@@ -27,11 +27,11 @@ After each automation checkpoint, a pop-up window will ask the user questions fo
2727

2828
When the test run completes, as seen from [this longer example](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test_1.py), you'll reach the results page that appears after answering all the verification questions. (Failed verifications generate links to screenshots and log files.)
2929

30-
![](https://seleniumbase.io/cdn/img/mqa_hybrid.png "MasterQA")
30+
![](https://seleniumbase.github.io/cdn/img/mqa_hybrid.png "MasterQA")
3131

3232
You may have noticed the ``Incomplete Test Runs`` row on the results page. If the value for that is not zero, it means that one of the automated steps failed. This could happen if you tell your script to perform an action on an element that doesn't exist. Now that we're mixing automation with manual QA, it's good to tell apart the failures from each. The results_table CSV file contains a spreadsheet with the details of each failure (if any) for both manual and automated steps.
3333

34-
#### How to run the example tests from scratch:
34+
**How to run the example tests from scratch:**
3535

3636
```bash
3737
git clone https://github.com/seleniumbase/SeleniumBase.git
@@ -44,7 +44,7 @@ pytest masterqa_test_1.py
4444

4545
At the end of your test run, you'll receive a report with results, screenshots, and log files. Close the Results Page window when you're done.
4646

47-
### Check out [masterqa_test_1.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test_1.py) to learn how to write your own MasterQA tests:
47+
**Check out [masterqa_test_1.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/masterqa_test_1.py) to learn how to write your own MasterQA tests:**
4848

4949
You'll notice that tests are written the same way as regular [SeleniumBase](https://seleniumbase.com) tests, with the key difference being a different import: ``from seleniumbase import MasterQA`` rather than ``from seleniumbase import BaseCase``. Now your Python test class will import ``MasterQA`` instead of ``BaseCase``.
5050

seleniumbase/utilities/selenium_grid/ReadMe.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
<!-- SeleniumBase Docs -->
22

3-
[<img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
3+
[<img src="https://seleniumbase.github.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
44

5-
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> The Selenium Grid Hub:</h2>
5+
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="28" /> The Selenium Grid Hub:</h2>
66

77
The Selenium Grid Hub lets you distribute tests to run in parallel across multiple node machines. Each node machine can then run its own allocation of tests. This allows you to run a large suite of tests very quickly.
88

9-
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Running the Selenium Grid Hub:</h3>
9+
<h3><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="28" /> Running the Selenium Grid Hub:</h3>
1010

1111
The following commands will work once you've installed seleniumbase.
1212

13-
<h4><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Downloading the Selenium Server JAR file:</h4>
13+
<h4><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="28" /> Downloading the Selenium Server JAR file:</h4>
1414

1515
```bash
1616
seleniumbase download server
1717
```
1818

1919
* (Required for using your own Selenium Grid)
2020

21-
<h4><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Grid Hub server controls:</h4>
21+
<h4><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="28" /> Grid Hub server controls:</h4>
2222

2323
```bash
2424
seleniumbase grid-hub {start|stop|restart} [OPTIONS]
@@ -30,7 +30,7 @@ seleniumbase grid-hub {start|stop|restart} [OPTIONS]
3030
<li> --timeout=TIMEOUT (Close idle browser after TIMEOUT sec.)</li>
3131
</ul>
3232

33-
<h4><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Grid node server controls:</h4>
33+
<h4><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="28" /> Grid node server controls:</h4>
3434

3535
```bash
3636
seleniumbase grid-node {start|stop|restart} --hub=[HUB_IP] [OPTIONS]
@@ -97,6 +97,6 @@ pytest test_demo_site.py --protocol=https --server=IP_ADDRESS --port=PORT
9797

9898
(For setting browser desired capabilities while running Selenium remotely, see the <a href="https://seleniumbase.io/help_docs/desired_capabilities/">desired capabilities documentation</a> and the sample files located in <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/capabilities">SeleniumBase/examples/capabilities</a>)
9999

100-
<h4><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> More info about the Selenium Grid Hub can be found here:</h4>
100+
<h4><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="28" /> More info about the Selenium Grid Hub can be found here:</h4>
101101

102102
* [https://www.selenium.dev/documentation/grid/](https://www.selenium.dev/documentation/grid/)

0 commit comments

Comments
 (0)