Skip to content

Commit

Permalink
docs(nx-cloud): update screenshots and information (#15984)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcabanes authored Apr 4, 2023
1 parent cfbdde9 commit e11e5d1
Show file tree
Hide file tree
Showing 32 changed files with 33 additions and 51 deletions.
8 changes: 2 additions & 6 deletions docs/nx-cloud/account/google-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,9 @@ If your organization uses [Google Identity](https://cloud.google.com/identity) o

By default, when you invite a member by email, they can create a separate NxCloud account using their work e-mail address. **If their primary email address gets disabled, they will still be able to sign-in with their NxCloud account, unless you explicitly revoke their membership from the Members page.**

If you'd like them to sign-in with Google directly, which ensures they automatically lose access to their NxCloud account if their email gets disabled, you need to enable this option when inviting them:
If you'd like them to sign-in with Google directly, which ensures they automatically lose access to their NxCloud account if their email gets disabled, you need to enable this option when inviting them: "_Require Social OAuth Sign-In_". They will then only be able to accept the invite if they sign-in with Google directly.

![Require Google OAuth Sign-In toggle](/nx-cloud/account/require_google_signin.png)

They will then only be able to accept the invite if they sign-in with Google directly:

![Log In with Google Button](/nx-cloud/account/google_oauth.png)
![Require Google OAuth Sign-In toggle](/nx-cloud/account/require-google-signin.webp)

## SAML integration

Expand Down
Binary file added docs/nx-cloud/account/require-google-signin.webp
Binary file not shown.
19 changes: 7 additions & 12 deletions docs/nx-cloud/private/auth-single-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ than 1 admin to your workspace, to reduce the chance of losing access to it.

## Setting up third-party auth providers

For instructions on how to set up third-party auth providers please refer to these guides:
For instructions on how to set up third-party auth providers, please refer to these guides:

- [GitHub Auth](/nx-cloud/private-cloud/auth-github)
- [GitLab Auth](/nx-cloud/private-cloud/auth-gitlab)
Expand All @@ -40,23 +40,18 @@ For instructions on how to set up third-party auth providers please refer to the

## Inviting users

Once that's done, you can either login with your admin user (see instructions below on how to log-in with admin), or
directly via GitHub by hitting the "Log In" button:
Once that's done, you can either sign in with your admin user by using the form, or
directly via the configured third-party authentication providers by clicking the "_Sign In with configured third-party provider_" button:

![Main user login](/nx-cloud/private/images/main_user_login.png)

You can then go to your organisation's members page and start inviting people based on their GitHub username:

![Invite members](/nx-cloud/private/images/invite_members.png)
![Main user login](/nx-cloud/private/images/main-user-login.webp)

You can then go to your organisation's settings and then to the members page and start inviting people based on their GitHub username.
When you invite someone, Nx Cloud will generate a unique invite URL, which you can send to that person directly.

## Migrating from an admin-only set up to auth via a configured provider

If you already have an admin user that manages an existing Nx Cloud workspace, you can still login, even after you set up
GitHub auth. You'll find the admin log-in button here:

![Admin hidden login](/nx-cloud/private/images/admin_hidden_login.png)
If you already have an admin user that manages an existing Nx Cloud workspace, you can still login by using the login form, even after you set up
GitHub auth.

## Finding usernames

Expand Down
Binary file removed docs/nx-cloud/private/images/admin_hidden_login.png
Binary file not shown.
Binary file removed docs/nx-cloud/private/images/invite_members.png
Binary file not shown.
Binary file added docs/nx-cloud/private/images/main-user-login.webp
Binary file not shown.
Binary file removed docs/nx-cloud/private/images/main_user_login.png
Binary file not shown.
Binary file removed docs/nx-cloud/reference/access-tokens.png
Binary file not shown.
Binary file added docs/nx-cloud/reference/access-tokens.webp
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/nx-cloud/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ In `nx.json`, locate the `taskRunnerOptions` property. It will look something li
}
```

Under the options property, you can add an additional property called `encryptionKey`. This is what will be used to encrypt your artifacts.
Under the "options" property, you can add another property called `encryptionKey`. This is what will be used to encrypt your artifacts.

To instead use an environment variable to provide your secret key, run any Nx command as follows:

Expand Down
8 changes: 4 additions & 4 deletions docs/nx-cloud/reference/server-api.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Nx Cloud Server API Reference

## OpenAPI 3.0.3
## OpenAPI

The nx-api has an OpenAPI 3.0.3 spec definition available at:
The nx-api has an OpenAPI `3.0.3` spec definition available at:

https://cloud.nx.app/nx-cloud/api/definition.json
[https://cloud.nx.app/nx-cloud/api/definition.json](https://cloud.nx.app/nx-cloud/api/definition.json)

## Authenticating

To authenticate, you may use your tokens (accessible from Nx Cloud):

![Access tokens](/nx-cloud/reference/access-tokens.png)
![Access tokens](/nx-cloud/reference/access-tokens.webp)

Per the spec, you use this token in the `Authentication` header.

Expand Down
Binary file removed docs/nx-cloud/set-up/access-vcs-setup.png
Binary file not shown.
Binary file added docs/nx-cloud/set-up/access-vcs-setup.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/nx-cloud/set-up/add-github-repository.png
Binary file not shown.
Binary file removed docs/nx-cloud/set-up/add-gitlab-repository.png
Binary file not shown.
Binary file added docs/nx-cloud/set-up/add-gitlab-repository.webp
Binary file not shown.
10 changes: 4 additions & 6 deletions docs/nx-cloud/set-up/bitbucket-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ The Nx Cloud + Bitbucket Cloud Integration lets you access the result of every r

## Connecting Your Workspace

![Access VCS Setup](/nx-cloud/set-up/access-vcs-setup.png)
![Access VCS Setup](/nx-cloud/set-up/access-vcs-setup.webp)

Once on the VCS Integrations setup page, select "Bitbucket Cloud" in the platforms dropdown. You will be prompted to enter the name of your workspace, and its repository slug.
Once on the VCS Integrations setup page, select "Bitbucket". You will be prompted to enter the name of your workspace and its repository slug.

Identifying your workspace name and repository slug can be done by looking at the URL from Bitbucket.

Expand All @@ -18,14 +18,12 @@ https://bitbucket.org/[workspace]/[repository-slug]/src/main/

For example, the url `https://bitbucket.org/nrwl/large-monorepo/src/main/` has a workspace name of "nrwl", and a repository slug of "large-monorepo".

![Add Bitbucket Cloud Repository](/nx-cloud/set-up/add-bitbucket-cloud-repository.png)
![Add Bitbucket Cloud Repository](/nx-cloud/set-up/add-bitbucket-cloud-repository.webp)

### Configuring Authentication

#### Using an App Password

To use an app password for authentication, one must be generated with proper permissions. The minimum required permissions are write access to PRs.

![PR write access is checked in the App Password creation screen on Bitbucket](/nx-cloud/set-up/minimal-bitbucket-cloud-app-password.png)

Once the app password is created, verify the username is correct, paste the value, and then click "Test Connection". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved, and setup is complete.
Once the app password is created, verify the username is correct, paste the value, and then click "Connect". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved, and setup is complete.
21 changes: 9 additions & 12 deletions docs/nx-cloud/set-up/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,30 @@ For the best experience, install the [Nx Cloud GitHub App](https://github.com/ma

## Connecting Your Workspace

Once you have installed the Nx Cloud GitHub App, you must link your workspace to the installation. To do this, sign in to Nx Cloud and navigate to the VCS Integrations setup page. This page can be found by clicking on the status card in the sidebar, or by clicking "Workspace Options" -> "VCS Integrations".
Once you have installed the Nx Cloud GitHub App, you must link your workspace to the installation. To do this, sign in to Nx Cloud and navigate to the VCS Integrations setup page. This page can be found in your workspace settings, you need to be admin of the organization in order to access it.
Once on the VCS Integrations setup page, you can choose what VCS you want to connect to your workspace.

![Access VCS Setup](/nx-cloud/set-up/access-vcs-setup.png)

Once on the VCS Integrations setup page, select "GitHub" in the platforms dropdown. You will be prompted to enter the name of your repository.

![Add GitHub Repository](/nx-cloud/set-up/add-github-repository.png)
![Access VCS Setup](/nx-cloud/set-up/access-vcs-setup.webp)

### Choosing an Authentication Method

It is easier to configure the Nx Cloud GitHub Integration to use its GitHub App to authenticate, and this method should be preferred for users on Nx Public Cloud. Advanced users, or Nx Enterprise clients may instead wish to generate a personal access token instead.
It is easier to configure the Nx Cloud GitHub Integration to use its GitHub App to authenticate, and this method should be preferred for users on Nx Public Cloud. Advanced users or Nx Enterprise clients may instead wish to generate a personal access token instead.

#### Using the GitHub App

To use the Nx Cloud GitHub App for authentication, select the radio button and then click "Test Connection". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved. Check the CI Platform Considerations section below and if there are no additional instructions for your platform of choice, setup is complete.
To use the Nx Cloud GitHub App for authentication, select the radio button and then click "Connect".
This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved.
Check the "_CI Platform Considerations_" section below and if there are no additional instructions for your platform of choice, setup is complete.

![Use GitHub App for Authentication](/nx-cloud/set-up/use-github-app-auth.png)
![Use GitHub App for Authentication](/nx-cloud/set-up/use-github-app-auth.webp)

#### Using a Personal Access Token

To use a Personal Access Token for authentication, one must be generated with proper permissions. The minimum required permissions are shown in the screenshot below.

![Minimum GitHub Personal Access Token Permissions](/nx-cloud/set-up/minimal-github-access-token.png)

Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Test Connection". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved. Check the CI Platform Considerations section below and if there are no additional instructions for your platform of choice, setup is complete.

![Use PAT for Authentication](/nx-cloud/set-up/use-github-pat-auth.png)
Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Connect". This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved. Check the "_CI Platform Considerations_" section below, and if there are no additional instructions for your platform of choice, setup is complete.

## CI Platform Considerations

Expand Down
12 changes: 4 additions & 8 deletions docs/nx-cloud/set-up/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ The Nx Cloud GitLab Integration lets you access the result of every run—with a

## Connecting Your Workspace

![Access VCS Setup](/nx-cloud/set-up/access-vcs-setup.png)
![Access VCS Setup](/nx-cloud/set-up/access-vcs-setup.webp)

Once on the VCS Integrations setup page, select "GitLab" in the platforms dropdown. You will be prompted to enter your project's ID.
Once on the VCS Integrations setup page, select "GitLab". You will be prompted to enter your project's ID.

![Locate Gitlab Project ID](/nx-cloud/set-up/find-gitlab-project-id.png)

To locate the ID for your project, visit the home page of your repository on GitLab. The value can be found underneath the name of your project, and has a clickable button to copy to your clipboard.

![Add GitLab Repository](/nx-cloud/set-up/add-gitlab-repository.png)
![Add GitLab Repository](/nx-cloud/set-up/add-gitlab-repository.webp)

### Configuring Authentication

Expand All @@ -24,14 +24,10 @@ To use a Personal Access Token for authentication, one must be generated with pr

![Minimum GitLab Personal Access Token Permissions](/nx-cloud/set-up/minimal-gitlab-access-token.png)

Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Test Connection".

![Use PAT for Authentication](/nx-cloud/set-up/use-gitlab-pat-auth.png)
Once this token is created, select the radio button for providing a personal access token, paste the value, and then click "Connect".

This will verify that Nx Cloud can connect to your repo. Upon a successful test, your configuration is saved, and setup is complete.

### Advanced Configuration

If your company runs a self-hosted GitLab installation, you may need to override the default URL that Nx Cloud uses to connect to the GitLab API. To do so, check the box labeled "Override GitLab API URL" and enter the correct URL for your organization.

![Override GitLab API URL](/nx-cloud/set-up/override-gitlab-api-url.png)
Binary file removed docs/nx-cloud/set-up/override-gitlab-api-url.png
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/nx-cloud/set-up/record-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ To record a command with Nx Cloud:

Commands that Nx Cloud stores will appear under your "Runs" view. For easy identification, the stored output will be displayed as a "record-output" target being invoked on the "nx-cloud-tasks-runner" project.

![nx-cloud record -- nx format:check](/nx-cloud/set-up/record-format-check.png)
![nx-cloud record -- nx format:check](/nx-cloud/set-up/record-format-check.webp)

If you use the Nx Cloud GitHub Integration, links to recorded output will also be displayed based on the exit code in the summary comment.

![Nx Cloud Report](/nx-cloud/set-up/record-report.png)
![Nx Cloud Report](/nx-cloud/set-up/record-report.webp)
Binary file removed docs/nx-cloud/set-up/record-format-check.png
Binary file not shown.
Binary file added docs/nx-cloud/set-up/record-format-check.webp
Binary file not shown.
Binary file removed docs/nx-cloud/set-up/record-report.png
Binary file not shown.
Binary file added docs/nx-cloud/set-up/record-report.webp
Binary file not shown.
Binary file not shown.
Binary file removed docs/nx-cloud/set-up/use-github-app-auth.png
Binary file not shown.
Binary file added docs/nx-cloud/set-up/use-github-app-auth.webp
Binary file not shown.
Binary file removed docs/nx-cloud/set-up/use-github-pat-auth.png
Binary file not shown.
Binary file removed docs/nx-cloud/set-up/use-gitlab-pat-auth.png
Binary file not shown.

1 comment on commit e11e5d1

@vercel
Copy link

@vercel vercel bot commented on e11e5d1 Apr 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-git-master-nrwl.vercel.app
nx-five.vercel.app
nx.dev
nx-dev-nrwl.vercel.app

Please sign in to comment.