Project settings docs

source/guides/dashboard/projects.md

@@ -51,11 +51,13 @@ Make sure you {% url "install" installing-cypress %} and {% url "open" installin
 
 # Identification
 
-***Project ID***
+Cypress uses your {% urlHash "`projectId`" Project-ID %} and {% urlHash "Record Key" Record-key %} together to uniquely identify projects.
+
+## Project ID
 
 Once you set up your project to record, we generate a unique `projectId` for your project and automatically insert it into your `cypress.json` file.
 
-***The `projectId` is a 6 character string in your `cypress.json`:***
+### The `projectId` is a 6 character string in your `cypress.json`
 
 ```json
 {
@@ -65,43 +67,89 @@ Once you set up your project to record, we generate a unique `projectId` for you
 
 This helps us uniquely identify your project. If you manually alter this, **Cypress will no longer be able to identify your project or find the recorded builds for it**.
 
-If you're using source control, we recommend that you check your `cypress.json` including the `projectId` into source control. If you don't want your `projectId` visible in your source code you can set it as an environment variable from your CI provider using the name `CYPRESS_PROJECT_ID`. The exact mechanism for doing so depends on your CI provider but could be as simple as:
+If you're using source control, we recommend that you check your `cypress.json`, including the `projectId`, into source control. If you don't want your `projectId` visible in your source code you can set it as an environment variable using the name `CYPRESS_PROJECT_ID`. The exact mechanism for doing so depends on your system but could be as simple as:
 
 ```shell
 export CYPRESS_PROJECT_ID={projectId}
 ```
 
 ## Record key {% fa fa-key %}
 
+The record key is used to authenticate that your project is *allowed* to record tests to the Dashboard Service. As long as your record key stays *private*, nobody will be able to record test runs for your project - even if they have your `projectId`.
+
+If you have a public project you should *still* keep your record key secret. If someone knows both your record key and your `projectId`, they could record test runs for your project - which could mix up all of your results and be counted towards your usage during billing.
+
+Think of your record key as the key that enables you to *write and create* runs. However, it has nothing to do with being able to *read or see* runs once they are recorded.
+
+{% note warning  %}
+If your Record Key is accidentally exposed, you should {% urlHash "delete it" Delete-record-key %} and {% urlHash "create a new one" Create-new-record-key %}.
+{% endnote %}
+
 Once you're set up to record test runs, we automatically generate a *Record Key* for the project.
 
-***A record key is a GUID that looks like this:***
+### A record key is a GUID that looks like this
 
 ```text
 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 %}. You can also find your Record Key inside of the *Settings* tab in the Test Runner.
+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" %}
+
+You can also find your Record Key inside of the *Settings* tab in the Test Runner.
 
 {% imgTag /img/dashboard/record-key-shown-in-desktop-gui-configuration.png "Record Key in Configuration Tab" %}
 
-# Authentication
+# Record keys
 
-Cypress uses your `projectId` and *Record Key* together to uniquely identify projects.
+See {% urlHash "Record key" Record-key %} for a full description of how the record keys are used.
 
-{% imgTag /img/dashboard/project-id-and-record-key-shown-in-dashboard.png "ProjectID and Record Keys in Dashboard" %}
+## Create new record key
 
-The record key is used to authenticate that your project is *allowed* to record. As long as your record key stays *private*, nobody will be able to record test runs for your project - even if they have your `projectId`.
+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" %}
+3. Go to the project's **Settings** page.
+  {% imgTag /img/dashboard/visit-project-settings.jpg "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" %}
+5. Click **Create New Key**. A new key will be automatically generated for your project.
 
-If you have a public project you should *still* keep your record key secret. If someone knows both your record key and your `projectId`, they could record test runs for your project - which would mix up all of your results!
+## Delete record key
 
-Think of your record key as the key that enables you to *write and create* runs. However, it has nothing to do with being able to *read or see* runs once they are recorded.
+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" %}
+3. Go to the project's **Settings** page.
+  {% imgTag /img/dashboard/visit-project-settings.jpg "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" %}
+5. Click **Delete** beside the record key you want to delete.
 
-{% note warning  %}
-If your Record Key is accidentally exposed, you should remove it and generate a new one from the {% url 'Dashboard Service' https://on.cypress.io/dashboard %}.
-{% endnote %}
+# Parallelization settings
+
+## Run completion delay
+
+You can edit the number of seconds that a run will wait for new groups to join before transitioning to 'completed'. See our {% url "parallelization guide" parallelization#Run-completion-delay %} to learn more.
+
+{% imgTag /img/dashboard/run-completion-delay.jpg "Run completion delay settings" %}
+
+# GitHub Integration
+
+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" %}
+
+See our {% url "GitHub Integration guide" github-integration %} to learn more.
+
+# Access to Runs
 
-# Public vs Private
+Visit your project settings to see who has access to your project's runs.
+
+{% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
+
+## Public vs Private
 
 - **Public** means that anyone can see the recorded test runs for the project. It is similar to how public projects on GitHub, Travis CI, or CircleCI are handled. Anyone who knows your `projectId` will be able to see the recorded runs for public projects.
 
@@ -111,14 +159,11 @@ If your Record Key is accidentally exposed, you should remove it and generate a
 
 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" %}
-3. Go to the project's settings page.
-
+3. Go to the project's **Settings** page.
   {% imgTag /img/dashboard/visit-project-settings.jpg "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.png "access-to-runs" %}
+  {% imgTag /img/dashboard/access-to-runs.jpg "access-to-runs" %}
 
 # Transfer ownership
 
@@ -128,11 +173,11 @@ You can transfer projects that you own to another {% url "organization" organiza
 
 1. Go to your organization's projects page.
 2. Select the project you wish to transfer.
-
   {% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
-3. Go to the project's settings page.
+3. Go to the project's **Settings** page.
   {% imgTag /img/dashboard/visit-project-settings.jpg "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" %}
 5. Select the user or organization, then click **Transfer**.
   {% imgTag /img/dashboard/transfer-ownership-of-project-dialog.png "Transfer Project dialog" %}
 
@@ -148,14 +193,15 @@ When a project is transferred to you, you will receive an email notifying you. Y
 
 {% imgTag /img/dashboard/accept-or-reject-transfer-of-project.png "Accept or reject a transferred project" %}
 
-# Delete
+# 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. Click into 'Runs' in the Dashboard.
-2. Click on the project you want to delete from the lefthand sidebar.
-3. Go to the project's settings page.
+1. Go to your organization's projects page.
+2. Select the project you want to remove.
+  {% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
+3. Go to the project's **Settings** page.
   {% imgTag /img/dashboard/visit-project-settings.jpg "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" %}
+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**.

source/guides/guides/parallelization.md

@@ -261,9 +261,7 @@ This waiting period is called the **run completion delay** and it begins after t
 
 {% imgTag /img/guides/parallelization/run-completion-delay.png "Test run completion delay" "no-border" %}
 
-This **delay is 60 seconds by default**, but is configurable within the {% url "Dashboard" dashboard-introduction%} project settings page:
-
-{% imgTag /img/guides/parallelization/project-run-delay-setting.png "Dashboard project run completion delay setting" %}
+This **delay is 60 seconds by default**, but is {% url "configurable within the Dashboard" project settings page" projects#Run-completion-delay %}.
 
 # Visualizing parallelization and groups in the Dashboard
 

source/zh-cn/guides/dashboard/projects.md

@@ -51,11 +51,13 @@ title: 项目
 
 # 标识符
 
-***项目ID***
+Cypress uses your {% urlHash "`projectId`" 项目ID %} and {% urlHash "Record Key" 录制秘钥 %} together to uniquely identify projects.
+
+## 项目ID
 
 一旦将项目设置为要录制，我们会为你的项目生成一个唯一的`projectId`并自动插入到你的`cypress.json`配置文件里。
 
-***这个`projectId`是在你`cypress.json`里的，一个6位字符的字符串：***
+### 这个`projectId`是在你`cypress.json`里的，一个6位字符的字符串：
 
 ```json
 {
@@ -73,9 +75,23 @@ export CYPRESS_PROJECT_ID={projectId}
 
 ## 录制秘钥 {% fa fa-key %}
 
+Cypress使用你的`projectId`和*Record Key*，结合起来唯一标识你的项目。
+
+{% imgTag /img/dashboard/project-id-and-record-key-shown-in-dashboard.png "ProjectID and Record Keys in Dashboard" %}
+
+录制秘钥用来确认你的项目是否*允许*录制。只要你的录制秘钥还是 *private*（私有的），就没有其他人可以对你的项目进行录制 - 哪怕他们有`projectId`(也不行)。
+
+即使你的项目是public（公共的），你 *也* 应该对你的录制秘钥保密。如果有人知道了你的录制秘钥和`projectId`，他们就可以对你的项目进行录制 - 这可能会导致你所有的测试结果是混淆不堪的！
+
+其实，你的录制秘钥是用来使能你的某次运行是 *可编辑和可创建* 的，然而，它与那次运行在录制完成后是否是 *可读和可查看的* 无关。
+
+{% note warning  %}
+如果你的录制秘钥意外暴露了，你应该删除它，并在{% url '数据面板服务' https://on.cypress.io/dashboard %}里生成一个新的。
+{% endnote %}
+
 一旦将项目设置为要录制，我们会自动为该项目生成一个*录制秘钥*。
 
-***一个录制秘钥就是类似下面的一个GUID（全局唯一标识符）：***
+### 一个录制秘钥就是类似下面的一个GUID（全局唯一标识符）:
 
 ```text
 f4466038-70c2-4688-9ed9-106bf013cd73
@@ -85,21 +101,49 @@ f4466038-70c2-4688-9ed9-106bf013cd73
 
 {% imgTag /img/dashboard/record-key-shown-in-desktop-gui-configuration.png "Record Key in Configuration Tab" %}
 
-# 授权
+# Record keys
 
-Cypress使用你的`projectId`和*Record Key*，结合起来唯一标识你的项目。
+See {% urlHash "Record key" 录制秘钥 %} for a full description of how the record keys are used.
 
-{% imgTag /img/dashboard/project-id-and-record-key-shown-in-dashboard.png "ProjectID and Record Keys in Dashboard" %}
+## Create new record key
 
-录制秘钥用来确认你的项目是否*允许*录制。只要你的录制秘钥还是 *private*（私有的），就没有其他人可以对你的项目进行录制 - 哪怕他们有`projectId`(也不行)。
+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" %}
+3. Go to the project's **Settings** page.
+  {% imgTag /img/dashboard/visit-project-settings.jpg "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" %}
+5. Click **Create New Key**. A new key will be automatically generated for your project.
 
-即使你的项目是public（公共的），你 *也* 应该对你的录制秘钥保密。如果有人知道了你的录制秘钥和`projectId`，他们就可以对你的项目进行录制 - 这可能会导致你所有的测试结果是混淆不堪的！
+## 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" %}
+3. Go to the project's **Settings** page.
+  {% imgTag /img/dashboard/visit-project-settings.jpg "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" %}
+5. Click **Delete** beside the record key you want to delete.
 
-{% note warning  %}
-如果你的录制秘钥意外暴露了，你应该删除它，并在{% url '数据面板服务' https://on.cypress.io/dashboard %}里生成一个新的。
-{% endnote %}
+# Parallelization settings
+
+## Run completion delay
+
+You can edit the number of seconds that a run will wait for new groups to join before transitioning to 'completed'. See our {% url "parallelization guide" parallelization#Run-completion-delay %} to learn more.
+
+{% imgTag /img/dashboard/run-completion-delay.jpg "Run completion delay settings" %}
+
+# GitHub Integration
+
+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" %}
+
+See our {% url "GitHub Integration guide" github-integration %} to learn more.
+
+# Access to Runs
 
 # 公有 vs 私有
 
@@ -111,14 +155,11 @@ Cypress使用你的`projectId`和*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" %}
 3. Go to the project's settings page.
-
   {% imgTag /img/dashboard/visit-project-settings.jpg "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.png "access-to-runs" %}
+  {% imgTag /img/dashboard/access-to-runs.jpg "access-to-runs" %}
 
 # 转让所有权
 
@@ -128,11 +169,11 @@ Cypress使用你的`projectId`和*Record Key*，结合起来唯一标识你的
 
 1. Go to your organization's projects page.
 2. Select the project you wish to transfer.
-
   {% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
 3. Go to the project's settings page.
   {% imgTag /img/dashboard/visit-project-settings.jpg "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" %}
 5. Select the user or organization, then click **Transfer**.
   {% imgTag /img/dashboard/transfer-ownership-of-project-dialog.png "Transfer Project dialog" %}
 
@@ -152,10 +193,11 @@ Cypress使用你的`projectId`和*Record Key*，结合起来唯一标识你的
 
 你可以删除你拥有的项目。同时这将删除项目所有的录制。删除项目也只能在{% url '数据面板服务' https://on.cypress.io/dashboard %}里进行。
 
-1. 在面板里点进'Runs'；
-2. 从左侧边栏里点击你想要的删除的项目；
+1. Go to your organization's projects page.
+2. Select the project you want to remove.
+  {% imgTag /img/dashboard/select-cypress-project.jpg "Select a project" %}
 3. 在本页的右侧点击'Settings'；
   {% imgTag /img/dashboard/visit-project-settings.jpg "Visit project settings" %}
 4. 在Settings页面的底部，点击"Remove Project"按钮
-
-{% imgTag /img/dashboard/remove-project-dialog.png "Delete project dialog" %}
+  {% imgTag /img/dashboard/remove-project-dialog.png "Delete project dialog" %}
+5. Confirm that you want to delete the project by clicking **Yes, Remove Project**.

source/zh-cn/guides/guides/parallelization.md

@@ -261,9 +261,7 @@ cypress run --record --parallel --ci-build-id $BUILD_TAG
 
 {% imgTag /img/guides/parallelization/run-completion-delay.png "Test run completion delay" "no-border" %}
 
-这个**延迟默认为60秒**，但是可以在{% url "仪表盘" dashboard-introduction%}项目设置页面中配置：
-
-{% imgTag /img/guides/parallelization/project-run-delay-setting.png "Dashboard project run completion delay setting" %}
+这个**延迟默认为60秒**，but is {% url "configurable within the Dashboard" project settings page" projects#Run-completion-delay %}.
 
 # 在仪表盘中可视化并行和分组