Skip to content

Commit

Permalink
refining docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dsheiko committed Nov 27, 2019
1 parent 43e9443 commit 9b4f78f
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 19 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Puppetry is an open-source cross-platform desktop application that gives non-dev

![Puppetry - codeless end-to-end test automation, integrated with CI/CD pipeline](https://github.com/dsheiko/puppetry/raw/master/docs/assets/img/puppetry-welcome.png)

[:tv: Watch introduction video](https://vimeo.com/345458272 "Introduction to Puppetry 2")
[:tv: Watch introduction video](https://youtu.be/dfuNhTCRMRg "Recording Automated Tests with Puppetry")


# Key Features
Expand All @@ -34,7 +34,6 @@ Puppetry is an open-source cross-platform desktop application that gives non-dev
- [Built-in automation recorder](https://docs.puppetry.app/suite#recording-suite-showcase)
- [Interactive mode](https://docs.puppetry.app/v/3.0.0/running-tests/interactive-mode), where one can navigate test steps similar to Cypress
- [Version control (GIT integration)](https://docs.puppetry.app/v/3.0.0/version-control)
- [Testing flows with transactional emails](https://docs.puppetry.app/testing-emails)
- Support Allure test reports
- Support of distinct testing types:
- [Functional testing](https://docs.puppetry.app/v/3.0.0/getting-started)
Expand Down Expand Up @@ -88,6 +87,17 @@ Please adhere the coding style. We have one based on jQuery's JavaScript Style G
and lint the code by running `npm run lint`


## Thanks

A special thanks to
[Monika Rao](https://github.com/monika-12),
[vteixeira19](https://github.com/vteixeira19),
[Gernot Messow](https://github.com/uvexgmessow),
[Carlos Mantilla](https://github.com/ceoaliongroo),
[kkmuffme](https://github.com/kkmuffme),
[Ravindra Jadhav](https://github.com/jadhavravindra)
for the ideas and support

## Credits

- [Electron](http://electronjs.org/)
Expand Down
22 changes: 22 additions & 0 deletions docs/assets/index.css
Original file line number Diff line number Diff line change
Expand Up @@ -493,4 +493,26 @@ img.lazyload:not([src]) {
font-size: 76px;
width: 76px;
height: 76px;
}

.video-thumb {
margin: 16px 0;
width: 200px;
height: 113px;
overflow: hidden;
border-radius: 8px;
border: 2px solid white;
}

.video-thumb img {
width: 200px;
height: 113px;
transition: transform .3s ease;
will-change: transition;
border-radius: 8px;
}

.video-thumb:hover img {
transform: scale(1.04);
filter: brightness(120%);
}
27 changes: 17 additions & 10 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!DOCTYPE html>
<html>
<html lang="en">
<head>
<title>Puppetry - codeless end-to-end test automation, integrated with CI/CD pipeline</title>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<link href="./assets/index.css?8" rel="stylesheet" type="text/css">
<link href="./assets/index.css?11" rel="stylesheet" type="text/css">


<meta name="description" content="Open source cross-platform IDE for functional automated testing built on top of Puppeteer and Jest. With Puppetry QA engineers can record and manage test cases instead of coding.">
Expand Down Expand Up @@ -37,9 +37,9 @@

<link rel="canonical" href="https://puppetry.app">

<link rel="preconnect" href="https://www.google-analytics.com">
<link rel="preconnect" href="https://api.github.com">
<link rel="preconnect" href="https://connect.facebook.net">
<link rel="preconnect" href="https://www.google-analytics.com" crossorigin>
<link rel="preconnect" href="https://api.github.com" crossorigin>
<link rel="preconnect" href="https://connect.facebook.net" crossorigin>

<script type="application/ld+json">
{
Expand Down Expand Up @@ -138,11 +138,18 @@ <h1>Welcome to Puppetry</h1>
/>

<h2>CODELESS END-TO-END AUTOMATED TESTING</h2>
<div class="banner__btns">
<a href="https://www.youtube.com/watch?v=xrtC2ucgP9o"
title="Watch video"

<div class="video-thumb">
<a href="https://youtu.be/dfuNhTCRMRg"
title="Watch video: Recording Automated Tests with Puppetry"
aria-label="Watch video"
target="_blank" class="btn btn--secondary btn--md" role="button">Watch video</a>
target="_blank" role="button">
<img src="/assets/img/v3/video-thumb.png?" alt="Watch video" />
</a>
</div>

<div class="banner__btns">

<a href="https://docs.puppetry.app" target="_blank" class="btn btn--secondary btn--md"
title="Puppetry Documentation"
aria-label="Puppetry Documentation" role="button">Read docs</a>
Expand All @@ -155,7 +162,7 @@ <h2>CODELESS END-TO-END AUTOMATED TESTING</h2>

<div class="hero-grid">
<div class="hero-card">
<img class="hero-card__icon" src="./assets/img/round-touch_app-24px.svg" alt="Web testing solution for non-developers" />
<img class="hero-card__icon" src="/assets/img/round-touch_app-24px.svg" alt="Web testing solution for non-developers" />
<h3>Web testing solution for non-developers</h3>
<p>
Puppetry requires neither programming skills nor experience with any of web-drivers/frameworks.
Expand Down
2 changes: 1 addition & 1 deletion project-demo/.puppetryrc
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
}
}
},
"savedAt": 1574684710,
"savedAt": 1574779364,
"modified": false,
"lastOpenSuite": "todomvc.json",
"variables": {
Expand Down
2 changes: 1 addition & 1 deletion project-demo/todomvc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"timeout": 50000,
"snippets": false,
"savedAt": 1574684710,
"loadedAt": 1574684688,
"loadedAt": 1574779347,
"modified": false,
"filename": "todomvc.json",
"targets": {
Expand Down
8 changes: 6 additions & 2 deletions project-test/.puppetryrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"appPanels": {
"suite": {
"panes": [
"targets"
"groups"
]
},
"settings": {
Expand Down Expand Up @@ -485,6 +485,10 @@
"57yk34jpj96": {
"key": "57yk34jpj96",
"value": true
},
"7vnk2vvpx9i": {
"key": "7vnk2vvpx9i",
"value": true
}
}
},
Expand All @@ -511,7 +515,7 @@
}
}
},
"savedAt": 1574424146,
"savedAt": 1574780615,
"modified": false,
"lastOpenSuite": "chained-target.json",
"variables": {},
Expand Down
6 changes: 3 additions & 3 deletions project-test/chained-target.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"timeout": 50000,
"snippets": false,
"description": "",
"savedAt": 1574089644,
"loadedAt": 1574423663,
"modified": true,
"savedAt": 1574780563,
"loadedAt": 1574780354,
"modified": false,
"filename": "chained-target.json",
"targets": {
"7vnk2vvh36o": {
Expand Down

0 comments on commit 9b4f78f

Please sign in to comment.