Skip to content

Commit

Permalink
Merge pull request #56 from MobyNL/upgrade-docusaurus-3.3.2
Browse files Browse the repository at this point in the history
Upgrade docusaurus 3.3.2
  • Loading branch information
manykarim authored Aug 29, 2024
2 parents 2b177b3 + 98a95bc commit e7c5efa
Show file tree
Hide file tree
Showing 11 changed files with 8,649 additions and 16,335 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 16.x
node-version: 18.x
cache: npm
cache-dependency-path: './website/package-lock.json'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 16.x
node-version: 18.x
cache: npm
cache-dependency-path: './website/package-lock.json'

Expand Down
14 changes: 7 additions & 7 deletions website/docs/about/about_us.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ title: About RF Guides
## Who we are

We are a group of Robot Framework users who like to share their good practices and knowledge.
The rich **Robot Framework ecosystem** - with its tools and libraries - is as important to us as the **Robot Framework Core** itself.
The rich **Robot Framework ecosystem** - with its tools and libraries - is as important to us as the **Robot Framework Core** itself.

So a lot of our guides will also focus on the ecosystem.
So a lot of our guides will also focus on the ecosystem.
We want to show you what **tools and practices** might help you on your Robot Framework journey.
Help you to be *successful* - and also to have *more fun*.

Expand All @@ -18,11 +18,11 @@ We hope that people will find this guide useful and that it will help them to wr
## Why we do this

When I started using Robot Framework, I was always impressed with the documentation and the examples.
The [User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html) and the [Keyword Documentation](https://robotframework.org/robotframework/#standard-libraries) were very helpful and always open in by browser while working.
The [User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html) and the [Keyword Documentation](https://robotframework.org/robotframework/#standard-libraries) were very helpful and always open in by browser while working.

When I discovered the [Slack Channel](https://slack.robotframework.org/), I got another productivity boost. My questions there were answered quicker than by any professional support of any tool I've ever used.

But there was also another thing I noticed:
But there was also another thing I noticed:
Some of the question were repeating.
- "Which IDE shall I used?"
- "What extensions do I need?"
Expand All @@ -33,15 +33,15 @@ Some of the question were repeating.

Often, the answers were provided.
But a Slack channel is not helpful for storing information or searching for it.
So we needed a different platform to conserve that information - allowing other users to find that information easily.
So we needed a different platform to conserve that information - allowing other users to find that information easily.
That's when **Robot Framework Guides** was born.

## How we do this

We want to be sure, our guides are helpful to a lot of people.
We want to be sure, our guides are helpful to a lot of people.
But as people learn differently, we did not want to focus on one specific method or medium.

So you will find
So you will find
- some written guides
- combined with links to existing videos
- maybe some embedded code examples
Expand Down
23 changes: 13 additions & 10 deletions website/docs/flaky_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ sidebar_label: Re-Execute failed tests
title: Re-Execute failed tests
---

[HOW TO! Rerun failed testcases in Robot Framework](https://youtu.be/537Os9GVXLk?si=nskKyTmLr0OEfXjJ)
[HOW TO! Rerun failed testcases in Robot Framework](https://youtu.be/537Os9GVXLk?si=nskKyTmLr0OEfXjJ)

<iframe width="560" height="315" src="https://www.youtube.com/embed/537Os9GVXLk?si=nskKyTmLr0OEfXjJ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

## Re-Execute Failed Tests and merge results

It is possible to run the same test suite(s) multiple times - but only re-run the failed tests. Afterwards the results can be merged into a single results file using `rebot`.
It is possible to run the same test suite(s) multiple times - but only re-run the failed tests. Afterwards the results can be merged into a single results file using `rebot`.
You can find the required steps in the [Robot Framework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#merging-outputs)

```shell
Expand All @@ -26,33 +26,36 @@ The [RetryFailed Listener](https://github.com/MarketSquare/robotframework-retryf

Install with pip:

pip install robotframework-retryfailed
```shell
pip install robotframework-retryfailed
```

### Usage

Add the listener to your robot execution, via command line arguments.
When your tests do fail and you have tagged them with `test:retry(2)`, it will retry the test 2 times.
When your tests do fail and you have tagged them with `test:retry(2)`, it will retry the test 2 times.
Retry can be also set globally as a parameter to the listener.

#### Attaching Listener

Example:
```shell
robot --listener RetryFailed <your robot suite>

robot --listener RetryFailed <your robot suite>

robot --listener RetryFailed:1 <robot suite>
robot --listener RetryFailed:1 <robot suite>
```

Second one will by default retry once every failing test.

#### Tagging Tests

Example:
```robotframework
```robotframework
*** Test Cases ***
Test Case
[Tags] test:retry(2)
Log This test will be retried 2 times if it fails
```
```
Tagging tasks by `task:retry(3)` should also work.

## Wait Until Keyword Succeeds
Expand All @@ -68,4 +71,4 @@ Test Case
Wait Until Keyword Succeeds 2 min 5 sec My keyword argument
${result} Wait Until Keyword Succeeds 3x 200ms My keyword
${result} Wait Until Keyword Succeeds 3x strict: 200ms My keyword
```
```
58 changes: 29 additions & 29 deletions website/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,31 +36,31 @@ import VideoIcon from '/icons/video.svg';
![Docusaurus themed image](/img/rf_guides_light.svg#gh-light-mode-only)
![Docusaurus themed image](/img/rf_guides_dark.svg#gh-dark-mode-only)

We hope these guides will help you get started with Robot Framework **faster and easier**.
We hope these guides will help you get started with Robot Framework **faster and easier**.
If you have any questions, please reach out to our awesome community on [Slack](https://slack.robotframework.org/).

<Section title="Getting Started" description="Set up your machine to use Robot Framework">
<Card
title="Test Automation"
icon=<BugIcon/>
icon={<BugIcon/>}
description="How to set up Robot Framework for testing"
to="/docs/getting_started/testing"
/>
<Card
title="RPA"
icon=<BotIcon/>
icon={<BotIcon/>}
description="How to set up Robot Framework for Robotic Process Automation (RPA)"
to="/docs/getting_started/rpa"
/>
<Card
title="IDE"
icon=<Code2Icon/>
icon={<Code2Icon/>}
description="Install and set up your IDE for coding and debugging"
to="/docs/getting_started/ide"
/>
<Card
title="Videos"
icon=<VideoIcon/>
icon={<VideoIcon/>}
description="Check out the video tutorials"
to="/docs/getting_started/videos"
/>
Expand All @@ -69,37 +69,37 @@ If you have any questions, please reach out to our awesome community on [Slack](
<Section title="Libraries" description="Steering and Automating different technologies">
<Card
title="Library Overview"
icon=<ListIcon/>
icon={<ListIcon/>}
description="A list of different libraries available for Robot Framework"
to="/docs/different_libraries/overview"
/>
<Card
title="Which Library?"
icon=<HelpCircleIcon/>
icon={<HelpCircleIcon/>}
description="How to choose the right library for your use case"
to="/docs/different_libraries/how_to_find_library"
/>
<Card
title="Browser Library"
icon=<MonitorIcon/>
icon={<MonitorIcon/>}
description="Automate Web Applications"
to="/docs/different_libraries/browser"
/>
<Card
title="Selenium Library"
icon=<MonitorIcon/>
icon={<MonitorIcon/>}
description="Automate Web Applications"
to="/docs/different_libraries/selenium"
/>
<Card
title="Requests Library"
icon=<ArrowUpDownIcon/>
icon={<ArrowUpDownIcon/>}
description="Automate APIs"
to="/docs/different_libraries/requests"
/>
<Card
title="RPA"
icon=<BotIcon/>
icon={<BotIcon/>}
description="Libraries for Robotic Process Automation (RPA)"
to="/docs/different_libraries/rpa"
/>
Expand All @@ -108,37 +108,37 @@ If you have any questions, please reach out to our awesome community on [Slack](
<Section title="Examples" description="Examples which show how to use Robot Framework and its Libraries">
<Card
title="Examples Overview"
icon=<ListIcon/>
icon={<ListIcon/>}
description="A list of examples for Robot Framework"
to="/docs/examples/overview"
/>
<Card
title="Project Structure"
icon=<FolderTreeIcon/>
icon={<FolderTreeIcon/>}
description="How to organize your test/rpa project"
to="/docs/examples/project_structure"
/>
<Card
title="Vehicle Insurance Application"
icon=<CarIcon/>
icon={<CarIcon/>}
description="An vehicle insurance calculator web app that requires user inputs in multiple screens"
to="/docs/examples/insurance"
/>
<Card
title="ToDo App"
icon=<ListChecksIcon/>
icon={<ListChecksIcon/>}
description="A simple todo app built in different frameworks and automated using Browser Library"
to="/docs/examples/todo"
/>
<Card
title="Restful Booker"
icon=<BedIcon/>
icon={<BedIcon/>}
description="A room booking app with a REST API"
to="/docs/examples/restfulbooker"
/>
<Card
title="MFA Login"
icon=<LoginIcon/>
icon={<LoginIcon/>}
description="A Login page which requires a two-factor authentication with a TOTP code"
to="/docs/examples/mfa_login"
/>
Expand All @@ -147,67 +147,67 @@ If you have any questions, please reach out to our awesome community on [Slack](
<Section title="Docker and CI" description="How to run Robot Framework in Containers and in CI Systems">
<Card
title="Docker Images"
icon=<PackageIcon/>
icon={<PackageIcon/>}
description="Docker Images which can be used for testing"
to="/docs/using_rf_in_ci_systems/docker"
/>
<Card
title="CI Systems"
icon=<ToyBrickIcon/>
icon={<ToyBrickIcon/>}
description="Examples for different CI Systems"
to="/docs/using_rf_in_ci_systems/ci"
/>
</Section>

<Section title="Custom Libraries and APIs" description="How to extend Robot Framwork and unleash its full potential via the API">
<Card
title="Python Library"
icon=<FileCodeIcon/>
icon={<FileCodeIcon/>}
description="How to create your own library in Python"
to="/docs/extending_robot_framework/custom-libraries/python_library"
/>
<Card
title="Package and Release a Library"
icon=<RocketIcon/>
icon={<RocketIcon/>}
description="How to package and release your own custom library"
to="/docs/extending_robot_framework/custom-libraries/releasing_your_own_libraries"
/>
<Card
title="Parse Test Results"
icon=<MicroscopeIcon/>
icon={<MicroscopeIcon/>}
description="How to parse test results with the Result Visitor API"
to="/docs/parsing_results"
/>
<Card
title="Listeners"
icon=<EarIcon/>
icon={<EarIcon/>}
description="Hook into the Robot Framework execution process"
to="/docs/extending_robot_framework/listeners_prerun_api/listeners"
/>
<Card
title="PrerunModifiers"
icon=<ListStartIcon/>
icon={<ListStartIcon/>}
description="Interact with and modify the RF Model before the execution process"
to="/docs/extending_robot_framework/listeners_prerun_api/prerunmodifier"
/>
<Card
title="API"
icon=<ComponentIcon/>
icon={<ComponentIcon/>}
description="Interact with the RF API to create new solutions and integrations"
to="/docs/extending_robot_framework/listeners_prerun_api/rf-api"
/>
</Section>

<Section title="About Robot Framework Guides" description="Something about us and how to support the project">
<Card
title="About Us"
icon=<UsersIcon/>
icon={<UsersIcon/>}
description="Who we are and what we do"
to="/docs/about/about_us"
/>
<Card
title="Contribute"
icon=<HeartHandshakeIcon/>
icon={<HeartHandshakeIcon/>}
description="How to join and support us"
to="/docs/about/contribute"
/>
Expand Down
Loading

0 comments on commit e7c5efa

Please sign in to comment.