Skip to content

Update for new nav #2076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7,875 changes: 3,926 additions & 3,949 deletions package-lock.json

Large diffs are not rendered by default.

17 changes: 9 additions & 8 deletions source/guides/dashboard/github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: GitHub Integration
---

The Cypress Dashboard can integrate your Cypress tests with your GitHub workflow via commit {% urlHash 'status checks' Status-checks %} and {% urlHash 'pull-request comments' Pull-request-comments %}.
The Cypress Dashboard can integrate your Cypress tests with your GitHub workflow via commit {% urlHash 'status checks' Status-checks %} and {% urlHash 'pull request comments' Pull-request-comments %}.
{% imgTag /img/dashboard/github-integration/pull-request-cypress-integration-comments-github-checks.jpg "Cypress GitHub App PR" %}

{% note info %}
Expand All @@ -19,23 +19,24 @@ Before you can enable GitHub integration for your Cypress projects, you must fir

## Install via organization integration settings

1. Go to the Dashboard {% url "Organizations page" https://dashboard.cypress.io/#/organizations %}.
1. Go to the Dashboard {% url "Organizations page" https://dashboard.cypress.io/#/organizations %} or open the organization switcher.
2. Select the organization you wish to integrate with a GitHub account or GitHub organization.
{% imgTag /img/dashboard/select-cypress-organization.jpg "Select an organization" %}
{% imgTag /img/dashboard/select-cypress-organization.png "Select an organization" width-600 %}
3. Visit the selected organization's **Integrations** page via the side navigation.
{% imgTag /img/dashboard/github-integration/install-github-integration-with-cypress-from-org-settings.png "Install Cypress GitHub App from Integrations" %}
4. Click the **Install the Cypress GitHub App** button.
{% imgTag /img/dashboard/github-integration/install-github-integration-with-cypress-from-org-settings.jpg "Install Cypress GitHub App from Integrations" %}

## Install via project settings

1. Go to your organization's projects page.
1. Select your organization in the organization switcher.
{% imgTag /img/dashboard/select-cypress-organization.png "Select an organization" width-600 %}
2. Select the project you wish to integrate with a GitHub repository.
{% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
{% imgTag /img/dashboard/select-cypress-project.png "Select a project" %}
3. Go to the project's settings page.
{% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
{% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}
4. Scroll down to the **GitHub Integration** section.
5. Click the **Install the Cypress GitHub App** button.
{% imgTag /img/dashboard/github-integration/install-github-cypress-app-project-settings.jpg "Install GitHub Cypress App" %}
{% imgTag /img/dashboard/github-integration/install-github-cypress-app-project-settings.png "Install GitHub Cypress App" %}

## Cypress GitHub app installation process

Expand Down
12 changes: 7 additions & 5 deletions source/guides/dashboard/organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Organizations

Organizations are used to group projects and manage access to those projects.

{% imgTag /img/dashboard/organizations-listed-in-dashboard.png "Organizations" %}
{% imgTag /img/dashboard/organizations-listed-in-dashboard.png "Organizations" width-600 %}

# Features

Expand All @@ -17,9 +17,11 @@ Organizations are used to group projects and manage access to those projects.

## Create Org

You can create an organization from within the {% url "Dashboard Service" https://on.cypress.io/dashboard %} by going to the **Organizations** tab and clicking **{% fa fa-plus %} Add Organization**.
You can create an organization from within the {% url "Dashboard Service" https://on.cypress.io/dashboard %} by opening the organization switcher and clicking **{% fa fa-plus %} Create new organization**.

{% imgTag /img/dashboard/add-organization-dialog.png "Add Organization dialog" %}
{% imgTag /img/dashboard/create-org.png "Create new organization" width-600 %}

{% imgTag /img/dashboard/add-organization-dialog.png "Add Organization dialog" width-600 %}

## Personal Orgs

Expand Down Expand Up @@ -49,11 +51,11 @@ Follow the following process to request an OSS plan for your project:
2. Go the {% url "Organizations page" https://on.cypress.io/dashboard/organizations %} to select the organization you want to associate with an OSS plan. If you have no organizations, you can create one by clicking the **+ Add Organization** button.
> **Note**: Personal organizations cannot be used with an OSS plan.

{% imgTag /img/dashboard/oss-plan-2-select-org.png "Select or add organization" "no-border" %}
{% imgTag /img/dashboard/oss-plan-2-select-org.png "Select or add organization" "no-border width-600" %}
3. Go to the **Billing & Usage** page, and then click on the **Apply for an open source plan** link at the bottom of the page.
{% imgTag /img/dashboard/oss-plan-3-billing.png "Click Apply for an open source plan" "no-border" %}
4. Fill in and submit the OSS plan request form.
{% imgTag /img/dashboard/oss-plan-4-apply.png "OSS plan request form" "no-border" %}
{% imgTag /img/dashboard/oss-plan-4-apply.png "OSS plan request form" "no-border width-600" %}
5. You'll receive an email confirming your request. The Cypress Team will review your request and, if approved, an OSS plan subscription will be applied to your organization.

If you have any questions regarding the OSS plan, please feel free [contact us](mailto:hello@cypress.io).
Expand Down
44 changes: 23 additions & 21 deletions source/guides/dashboard/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ f4466038-70c2-4688-9ed9-106bf013cd73

You can create multiple Record Keys for a project, or delete existing ones from our {% url 'Dashboard' https://on.cypress.io/dashboard %}.

{% imgTag /img/dashboard/record-keys-in-project-settings-dashboard.jpg "Record key in project settings" %}
{% imgTag /img/dashboard/record-keys-in-project-settings-dashboard.png "Record key in project settings" %}

You can also find your Record Key inside of the *Settings* tab in the Test Runner.

Expand All @@ -109,22 +109,22 @@ See {% urlHash "Record key" Record-key %} for a full description of how the reco

1. Go to your organization's projects page.
2. Select the project you want to change access to.
{% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
{% imgTag /img/dashboard/select-cypress-project.png "Select a project" %}
3. Go to the project's **Settings** page.
{% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
{% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}
4. Here you will see a **Record Keys** section
{% imgTag /img/dashboard/record-keys-in-project-settings-dashboard.jpg "Record keys in Dashboard" %}
{% imgTag /img/dashboard/record-keys-in-project-settings-dashboard.png "Record keys in Dashboard" %}
5. Click **Create New Key**. A new key will be automatically generated for your project.

## Delete record key

1. Go to your organization's projects page.
2. Select the project you want to change access to.
{% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
{% imgTag /img/dashboard/select-cypress-project.png "Select a project" %}
3. Go to the project's **Settings** page.
{% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
{% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}
4. Here you will see a **Record Keys** section
{% imgTag /img/dashboard/record-keys-in-project-settings-dashboard.jpg "Record keys in Dashboard" %}
{% imgTag /img/dashboard/record-keys-in-project-settings-dashboard.png "Record keys in Dashboard" %}
5. Click **Delete** beside the record key you want to delete.

# Parallelization settings
Expand All @@ -137,17 +137,17 @@ You can edit the number of seconds that a run will wait for new groups to join b

# GitHub Integration

You can integrate your project with GitHub and edit its settings from within the project settings page.
You can integrate your project with GitHub and edit its settings from within the project settings page.

{% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
{% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}

See our {% url "GitHub Integration guide" github-integration %} to learn more.

# Access to Runs

Visit your project settings to see who has access to your project's runs.

{% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
{% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}

## Public vs Private

Expand All @@ -159,25 +159,25 @@ Visit your project settings to see who has access to your project's runs.

1. Go to your organization's projects page.
2. Select the project you want to change access to.
{% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
{% imgTag /img/dashboard/select-cypress-project.png "Select a project" %}
3. Go to the project's **Settings** page.
{% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
{% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}
4. Here you will see a section displaying **Access to Runs**. Choose the appropriate access you'd like to assign for the project here.
{% imgTag /img/dashboard/access-to-runs.jpg "access-to-runs" %}
{% imgTag /img/dashboard/access-to-runs.png "access-to-runs" %}

# Transfer ownership

## Transfer project to other user or organization

You can transfer projects that you own to another {% url "organization" organizations %} you are a part of or to another user in the organization. Projects can only be transferred from the {% url 'Dashboard Service' https://on.cypress.io/dashboard %}.

1. Go to your organization's projects page.
1. Select your organization in the organization switcher.
2. Select the project you wish to transfer.
{% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
{% imgTag /img/dashboard/select-cypress-project.png "Select a project" %}
3. Go to the project's **Settings** page.
{% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
{% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}
4. Scroll down to the **Transfer Ownership** section and click **Transfer Ownership**.
{% imgTag /img/dashboard/transfer-ownership-button.jpg "Transfer ownership button" %}
{% imgTag /img/dashboard/transfer-ownership-button.png "Transfer ownership button" %}
5. Select the user or organization, then click **Transfer**.
{% imgTag /img/dashboard/transfer-ownership-of-project-dialog.png "Transfer Project dialog" %}

Expand All @@ -189,19 +189,21 @@ Upon transferring, you can cancel the transfer at any time by visiting the organ

## Accept or reject transferred project

When a project is transferred to you, you will receive an email notifying you. You will be able to accept or reject the transferred project by visiting your organization's projects and clicking 'Accept' or 'Reject'.
When a project is transferred to you, you will receive an email notifying you. You will be able to accept or reject the transferred project by clicking the notification in the sidebar and clicking 'Accept' or 'Reject'.

{% imgTag /img/dashboard/see-pending-transfer.png "See pending transfer" %}

{% imgTag /img/dashboard/accept-or-reject-transfer-of-project.png "Accept or reject a transferred project" %}

# Delete Project

You can delete projects you own. This will also delete all of their recorded test runs. Deleting projects can only be done from the {% url 'Dashboard Service' https://on.cypress.io/dashboard %}.

1. Go to your organization's projects page.
1. Select your organization in the organization switcher.
2. Select the project you want to remove.
{% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
{% imgTag /img/dashboard/select-cypress-project.png "Select a project" %}
3. Go to the project's **Settings** page.
{% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
{% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}
4. At the very bottom of the Settings page click the **Remove Project** button.
{% imgTag /img/dashboard/remove-project-dialog.png "Delete project dialog" %}
5. Confirm that you want to delete the project by clicking **Yes, Remove Project**.
8 changes: 4 additions & 4 deletions source/guides/dashboard/runs.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,21 @@ You can see the result of each spec file that ran within **Specs**. There is als

The Timeline View charts your spec files as they ran relative to each other. This is especially helpful when you want to visualize how your tests ran in {% url "parallel" parallelization %}.

{% imgTag /img/dashboard/specs-timeline-view.jpg "Specs tab with timeline view" %}
{% imgTag /img/dashboard/specs-timeline-view.png "Specs tab with timeline view" %}

## Bar Chart View

The Bar Chart View charts the lengths of each spec file. This view is helpful to determine which spec files or tests are running longer than others.

{% imgTag /img/dashboard/specs-barchart-view.jpg "Specs tab with bar chart view" %}
{% imgTag /img/dashboard/specs-barchart-view.png "Specs tab with bar chart view" %}

## Jump to failed tests

If you had any failed tests, you can hover over the spec chart and click on the link to the failed test to go directly to its error message and stack trace.

{% imgTag /img/dashboard/specs-failures-popup.png "Failures popup on spec hover %}
{% imgTag /img/dashboard/specs-failures-popup.png "Failures popup on spec hover" %}

# {% fa fa-code fa-fw %} Standard output
## {% fa fa-code fa-fw %} Standard output

Standard output includes details and summaries of your tests for each spec file based on the {% url 'reporter' reporters %} you have set. By default it is the `spec` reporter.

Expand Down
4 changes: 2 additions & 2 deletions source/guides/dashboard/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can invite users to Cypress from the {% url 'Dashboard Service' https://on.c

1. Go the {% url "Organizations page" https://on.cypress.io/dashboard/organizations %} to select the organization you want to invite a user to.
2. Click **Users**, then **Invite User**. *Note: you must have the {% urlHash "role of 'owner' or 'admin'" User-roles %} to invite users.*
3. Fill in their email and select their {% urlHash "role" User-roles %} then click **Invite User** *Note: only 'owners can give other user's 'owner' access.*
3. Fill in their email and select their {% urlHash "role" User-roles %} then click **Invite User** *Note: only owners can give other users 'owner' access.*
4. The user will receive an invitation email with a link to accept the invitation.

{% imgTag /img/dashboard/invite-user-dialog.png "Invite User dialog" %}
Expand Down Expand Up @@ -59,4 +59,4 @@ The permissions for each user role for the Dashboard Service.

Users can "request" access to a given organization. If a developer on your team has access to Cypress and your project's source code - they can request to be given access to your organization. This means instead of you having to invite team members up front, they can request access and you can choose to accept or deny them access.

{% imgTag /img/dashboard/request-access-to-organization.png "Request access to project" %}
{% imgTag /img/dashboard/request-access-to-organization.png "Request access to project" %}
4 changes: 4 additions & 0 deletions themes/cypress/source/css/_partial/page.scss
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,10 @@ a.article-edit-link {
margin: 15px 0;
box-shadow: 0 1px 2px #ddd;

&.width-600 {
max-width: 600px;
}

&.no-border {
border: 0;
box-shadow: 0 0 0;
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified themes/cypress/source/img/dashboard/add-organization-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified themes/cypress/source/img/dashboard/dashboard-fail-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified themes/cypress/source/img/dashboard/dashboard-runs-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified themes/cypress/source/img/dashboard/invite-user-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified themes/cypress/source/img/dashboard/oss-plan-1-login.png
Binary file modified themes/cypress/source/img/dashboard/oss-plan-2-select-org.png
Binary file modified themes/cypress/source/img/dashboard/oss-plan-3-billing.png
Binary file modified themes/cypress/source/img/dashboard/oss-plan-4-apply.png
Diff not rendered.
Diff not rendered.
Binary file modified themes/cypress/source/img/dashboard/remove-project-dialog.png
Binary file modified themes/cypress/source/img/dashboard/run-details.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed themes/cypress/source/img/dashboard/spec-tab.png
Diff not rendered.
Diff not rendered.
Binary file modified themes/cypress/source/img/dashboard/specs-failures-popup.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.