Skip to content

Commit 18557f8

Browse files
authored
docs(misc): various updates embedding videos in docs pages
1 parent c933660 commit 18557f8

File tree

8 files changed

+44
-10
lines changed

8 files changed

+44
-10
lines changed

astro-docs/src/content/docs/getting-started/ai-setup.mdoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ Nx provides deep integration with AI coding assistants through the **Nx Model Co
1111

1212
## Configure Nx AI Integration
1313

14+
{% youtube
15+
src="https://youtu.be/8gdvIz2r_QM"
16+
title="Set Up AI Agents in Nx"
17+
/%}
18+
1419
### Automatic AI Setup
1520

1621
To automatically configure your Nx workspace to work best with AI agents and assistants, run the following command:

astro-docs/src/content/docs/getting-started/editor-setup.mdoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Nx Console editor extensions make your developer experience richer. The extensio
1414
- visualize dependencies between projects and tasks
1515
- and more!
1616

17+
You can explore more of the features [in our dedicated Nx Console guides](/docs/guides/nx-console).
18+
1719
## Download
1820

1921
### Official Integrations

astro-docs/src/content/docs/getting-started/nx-cloud.mdoc

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,19 @@ Nx Cloud improves many aspects of the CI/CD process:
1515
- **Cost** - 40% - 75% reduction in CI costs (observed on the Nx OSS monorepo)
1616
- **Reliability** - by automatically identifying flaky tasks (e2e tests in particular) and re-running them
1717

18-
{% call_to_action variant="default" title="Recover lost time with Nx Cloud" url="https://cloud.nx.app/get-started?utm_source=nx-dev&utm_medium=nx-cloud_intro&utm_campaign=try-nx-cloud" description="Setup takes less than 2 minutes" /%}
18+
## Connect your workspace to Nx Cloud
19+
20+
The most straightforward way to connect your Nx workspace with Nx Cloud is via the web application:
21+
22+
{% call_to_action variant="default" title="Create a new or connect an existing repo" url="https://cloud.nx.app/get-started?utm_source=nx-dev&utm_medium=nx-cloud_intro&utm_campaign=try-nx-cloud" description="Setup takes less than 2 minutes" /%}
23+
24+
Alternatively, you can also run the following command in your Nx workspace (make sure you have it pushed to a remote repository first):
25+
26+
```shell
27+
nx connect
28+
```
29+
30+
For more details, [follow our in-depth guide](/docs/guides/nx-cloud/setup-ci) for setting up CI with Nx.
1931

2032
## How Nx Cloud improves CI
2133

@@ -31,7 +43,7 @@ For example:
3143
- More work needs to run in CI - Add more agent machines, Nx Cloud automatically assigns available work to extra agent machines.
3244
- Known flaky tasks waste CI time on needed reruns - Nx Cloud automatically detects flaky tasks and reruns automatically in the current CI execution.
3345

34-
[Read more customer stories](https://nx.dev/blog?filterBy=customer+story)
46+
[Learn how our customers use Nx Cloud](https://nx.dev/blog?filterBy=customer+story) to help them scale their workspaces and be more efficient.
3547

3648
## Learn more
3749

astro-docs/src/content/docs/getting-started/start-new-project.mdoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ nx@latest init
3535
Make sure you have [Nx installed globally](/docs/getting-started/installation) or use `npx` if you're in a JavaScript environment
3636
{% /aside %}
3737

38-
Nx will detect the underlying workspace configuration, ask you a couple of questions and install itself into the workspace. As you keep going, you can incrementally add functionality, like:
38+
Nx will detect the underlying workspace configuration, ask you a couple of questions and install itself into the workspace. You can now [run tasks with Nx](/docs/features/run-tasks) and incrementally add functionality, like:
3939

4040
- [Configure caching](/docs/features/cache-task-results)
4141
- [Adding Nx plugins to help refine your workflows](/docs/plugin-registry)
@@ -55,12 +55,12 @@ This interactive command will guide you through the setup process, allowing you
5555

5656
- **Choose your workspace name** - This will be the name of your root directory
5757
- **Select your preferred package manager** - npm, yarn, or pnpm
58-
- **Pick a preset** - Choose from various technology stacks and configurations
58+
- **Pick a preset** - Choose from [various technology stacks and configurations](/docs/reference/create-nx-workspace#presets)
5959
- **Configure additional options** - Such as styling solutions, testing frameworks, and more
6060

6161
Choose a preset that matches your technology stack. This gives you a fully configured workspace.
6262

63-
You can also choose **an empty workspace preset** which sets up the bare minimum configuration including Nx itself. This allows you to add technologies and features incrementally over time as you need them.
63+
You can also choose **an empty workspace preset** (`--preset=ts`) which sets up the bare minimum configuration for TypeScript and Nx. This allows you to add technologies and features incrementally over time as you need them.
6464

6565
## Option 3: Get the complete Nx platform experience
6666

astro-docs/src/content/docs/getting-started/start-with-existing-project.mdoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ sidebar:
77
filter: 'type:Guides'
88
---
99

10+
{% course_video src="https://youtu.be/3hW53b1IJ84" courseTitle="From PNPM Workspaces to Distributed CI" courseUrl="https://nx.dev/courses/pnpm-nx-next/lessons-01-nx-init" /%}
11+
1012
In many situations, you have an existing codebase and want to improve it with Nx using an **incremental adoption approach**.
1113

1214
Thanks to [Nx's modular architecture](/docs/getting-started/intro), you can start with just **Nx Core** and then gradually add [technology-specific plugins](/docs/technologies), [CI integrations](/docs/getting-started/nx-cloud), or other capabilities as your requirements evolve.
@@ -25,12 +27,13 @@ Whether a monorepo, single project or something in between, `nx init` walks you
2527

2628
## Next Steps
2729

28-
After initializing Nx, you can explore your workspace with the following commands:
30+
After initializing Nx, you can [run tasks](/docs/features/run-tasks) with `nx <task> <project-name>` (e.g. `nx build myproject`) or run one or many tasks across all projects with `nx run-many -t <task1> <task2>`.
31+
32+
You can also explore your codebase using:
2933

3034
- `nx graph` to view an interactive graph
3135
- `nx show projects` to see a list of all projects
3236
- `nx show project <project-name>` to view an interactive project detailed view
33-
- `nx run-many -t <target>` to run tasks with Nx, e.g. `nx run-many -t build`
3437

3538
### Update CI Configurations
3639

astro-docs/src/content/docs/guides/Nx Cloud/setup-ci.mdoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,16 @@ sidebar:
66
filter: 'type:Guides'
77
---
88

9-
Learn how to set up Nx Cloud for your workspace with your preferred CI platform. Get started connecting to Nx Cloud by running `nx connect`.
9+
Learn how to set up Nx Cloud for your workspace with your preferred CI platform. Get started connecting to Nx Cloud by running
10+
11+
```shell
12+
nx connect
13+
```
1014

1115
Each platform has specific configurations and optimizations that help you build and test only what is affected, retrieve previous successful builds, and optimize CI performance.
1216

17+
{% course_video src="https://www.youtube.com/watch?v=8mqHXYIl_qI" courseTitle="From PNPM Workspaces to Distributed CI" courseUrl="https://nx.dev/courses/pnpm-nx-next/lessons-06-nx-cloud-setup" /%}
18+
1319
## CI Configuration
1420

1521
{% tabs syncKey="ci-provider" %}

docs/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,9 +304,15 @@ Have a more decent button-like widget that you can place below sections of a tut
304304
This is for embedding a video just like with the Youtube component, but in addition to have a link to a Nx Course (nx.dev/courses) video to improve the discoverability of these courses.
305305

306306
```markdown
307-
{% course-video src="https://youtu.be/3hW53b1IJ84" courseTitle="From PNPM Workspaces to Distributed CI" courseUrl="/courses/pnpm-nx-next/lessons-01-nx-init" title="Initialize Nx in Your Project with nx init" /%}
307+
{% course_video src="https://youtu.be/3hW53b1IJ84" courseTitle="From PNPM Workspaces to Distributed CI" courseUrl="/courses/pnpm-nx-next/lessons-01-nx-init" /%}
308308
```
309309

310+
Attributes:
311+
312+
- `src` (required): YouTube video URL
313+
- `courseTitle` (required): Title of the course
314+
- `courseUrl` (required): Link to the course page (e.g., `/courses/pnpm-nx-next/lessons-01-nx-init`)
315+
310316
#### Project Details View
311317

312318
Embed a Project Details View that is identical what is shown in Nx Console or `nx show project myproject --web`

nx-dev/ui-common/src/lib/course-video.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export function CourseVideo({
1616
courseUrl,
1717
}: CourseVideoProps): JSX.Element {
1818
return (
19-
<div className="not-prose mx-auto max-w-4xl">
19+
<div className="not-prose mx-auto max-w-4xl pt-4">
2020
<div className="overflow-hidden rounded-xl bg-slate-50 shadow-sm ring-1 ring-slate-900/5 dark:bg-slate-800/50 dark:ring-slate-700/50">
2121
<div className="aspect-video w-full">
2222
<YouTube

0 commit comments

Comments
 (0)