GitBook: [master] 33 pages and 15 assets modified

matteovivona · Feb 10, 2021 · d3dcbdc · d3dcbdc
1 parent bd9530f
commit d3dcbdc
Show file tree

Hide file tree

Showing 48 changed files with 1,377 additions and 0 deletions.
diff --git a/.gitbook/assets/aws-sorry-cypress.gif b/.gitbook/assets/aws-sorry-cypress.gif
diff --git a/.gitbook/assets/button.svg b/.gitbook/assets/button.svg
diff --git a/.gitbook/assets/ci_url.png b/.gitbook/assets/ci_url.png
diff --git a/.gitbook/assets/empty-dashboard.png b/.gitbook/assets/empty-dashboard.png
diff --git a/.gitbook/assets/heroku-001.png b/.gitbook/assets/heroku-001.png
diff --git a/.gitbook/assets/heroku-002.png b/.gitbook/assets/heroku-002.png
diff --git a/.gitbook/assets/launch-stack.svg b/.gitbook/assets/launch-stack.svg
diff --git a/.gitbook/assets/octolumbercat.png b/.gitbook/assets/octolumbercat.png
diff --git a/.gitbook/assets/parallelization-diagram.png b/.gitbook/assets/parallelization-diagram.png
diff --git a/.gitbook/assets/sc-project.png b/.gitbook/assets/sc-project.png
diff --git a/.gitbook/assets/sc-run-details.png b/.gitbook/assets/sc-run-details.png
diff --git a/.gitbook/assets/sc-run.png b/.gitbook/assets/sc-run.png
diff --git a/.gitbook/assets/shuttle.png b/.gitbook/assets/shuttle.png
diff --git a/.gitbook/assets/shuttle.svg b/.gitbook/assets/shuttle.svg
diff --git a/.gitbook/assets/sorry-cypress-arch.png b/.gitbook/assets/sorry-cypress-arch.png
diff --git a/README.md b/README.md
@@ -0,0 +1,32 @@
+# Documentation
+
+![](.gitbook/assets/octolumbercat.png)
+
+Sorry-cypress is an open-source, on-premise, self-hosted alternative to Cypress dashboard 🌲
+
+### ⭐️ Features
+
+* Run cypress tests in parallel without dashboard, no limitations
+* Upload screenshots and videos to your own storage
+* Self-hosted - use your own infrastructure, own your data
+* Integrate with GitHub, Slack and other 3rd party tools via web hooks
+* Browse test results, failures, screenshots and video recordings
+* Deploy on any popular cloud platform:
+  * Docker images
+  * Docker Compose files
+  * Kubernetes Helm Charts
+  * AWS
+  * Heroku
+  * Google Cloud
+  * Azure
+
+### 💎 Support
+
+
+
+{% hint style="info" %}
+Please help us by taking a short 1-minute [survey](https://forms.gle/qxoTPFiokLWuc6eZ7). Thank you!
+{% endhint %}
+
+
+
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -0,0 +1,59 @@
+# Table of contents
+
+* [Documentation](README.md)
+
+## Guide
+
+* [Get Started](guide/basic-setup.md)
+* [Dashboard and API](guide/dashboard-and-api.md)
+* [Cloud Setup](guide/cloud-setup.md)
+
+## Cloud <a id="cloud-setup"></a>
+
+* [AWS](cloud-setup/aws/README.md)
+  * [AWS S3 Manual Setup](cloud-setup/aws/aws-s3-storage.md)
+* [Google Cloud](cloud-setup/google-cloud.md)
+* [Microsoft Azure](cloud-setup/azure.md)
+* [Heroku](cloud-setup/heroku.md)
+* [Kubernetes](cloud-setup/kubernetes.md)
+* [Docker Images](cloud-setup/docker-images.md)
+
+## Configuration
+
+* [Basic Setup](configuration/in-memory.md)
+* [Full Setup](configuration/persistent.md)
+* [Director Service](configuration/director-configuration.md)
+* [API Service](configuration/api-configuration.md)
+* [Web Dashboard](configuration/dashboard-configuration.md)
+
+## Integrations
+
+* [Webhooks](integrations/webhooks.md)
+* [Slack Integration](integrations/slack-integration.md)
+* [GitHub Integration](integrations/github-integration.md)
+
+## Cypress Agent
+
+* [Parallelization Explained](cypress-agent/parallelization-guide.md)
+* [Agent Configuration](cypress-agent/configuring-cypress-agent.md)
+* [CLI One Liners](cypress-agent/cli-one-liners.md)
+* [Executable Wrapper](cypress-agent/wrapper.md)
+
+## CI
+
+* [GitHub Actions](ci/github-actions.md)
+* [Travis](ci/travis.md)
+* [Jenkins](ci/jenkins.md)
+* [AWS Codebuild](ci/aws-codebuild.md)
+
+## Development
+
+* [Development Guide](development/development-guide.md)
+
+---
+
+* [Community Content](community-content.md)
+* [❤️ Contributions](contributions.md)
+* [Support](support-us.md)
+* [FAQ](faq.md)
+
diff --git a/ci/aws-codebuild.md b/ci/aws-codebuild.md
@@ -0,0 +1,2 @@
+# AWS Codebuild
+
diff --git a/ci/github-actions.md b/ci/github-actions.md
@@ -0,0 +1,8 @@
+# GitHub Actions
+
+{% hint style="danger" %}
+Under construction
+{% endhint %}
+
+[https://github.com/sorry-cypress/sorry-cypress/issues/46](https://github.com/sorry-cypress/sorry-cypress/issues/46)
+
diff --git a/ci/jenkins.md b/ci/jenkins.md
@@ -0,0 +1,8 @@
+# Jenkins
+
+{% hint style="danger" %}
+Under construction
+{% endhint %}
+
+
+
diff --git a/ci/travis.md b/ci/travis.md
@@ -0,0 +1,8 @@
+# Travis
+
+{% hint style="danger" %}
+Under construction
+{% endhint %}
+
+
+