Skip to content

Commit af5e854

Browse files
authored
feat: replace "site" with "project" in UI copy and documentation (#7299)
* refactor: replace "site" with "project" in UI copy and documentation * refactor: update terminology from "site" to "project" across CLI codebase * revert some changes + use "project ID" instead of siteId in error messages * chore: run prettier * update tests * update snapshots + fix another test * fix: remove "project" * update siteId argument to id + updating another log with project ID * revert analytics change + revert comment * refactor: rename "site" to "project" in test descriptions * fix checks for create living test sites
1 parent e82926f commit af5e854

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+459
-445
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ netlify [command] help
8484

8585
## Documentation
8686

87-
To learn how to log in to Netlify and start deploying sites, visit the
87+
To learn how to log in to Netlify and start deploying projects, visit the
8888
[documentation on Netlify](https://docs.netlify.com/cli/get-started/).
8989

9090

@@ -121,4 +121,4 @@ MIT. See [LICENSE](LICENSE) for more details.
121121
[snyk-img]: https://snyk.io/test/npm/netlify-cli/badge.svg
122122
[snyk]: https://snyk.io/test/npm/netlify-cli
123123
[netlify-img]: https://api.netlify.com/api/v1/badges/d3807379-2dcf-4a43-9c00-e7e8d90ecf70/deploy-status
124-
[netlify]: https://app.netlify.com/sites/cli/deploys
124+
[netlify]: https://app.netlify.com/projects/cli/deploys

docs/commands/clone.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: Netlify CLI clone command
33
sidebar:
44
label: clone
5-
description: Clone a remote repo and link it to an existing site on Netlify
5+
description: Clone a remote repo and link it to an existing project on Netlify
66
---
77

88
# `clone`
99

1010
<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
11-
Clone a remote repository and link it to an existing site on Netlify
12-
Use this command when the existing Netlify site is already configured to deploy from the existing repo.
11+
Clone a remote repository and link it to an existing project on Netlify
12+
Use this command when the existing Netlify project is already configured to deploy from the existing repo.
1313

1414
If you specify a target directory, the repo will be cloned into that directory. By default, a directory will be created with the name of the repo.
1515

16-
To specify a site, use --id or --name. By default, the Netlify site to link will be automatically detected if exactly one site found is found with a matching git URL. If we cannot find such a site, you will be interactively prompted to select one.
16+
To specify a project, use --id or --name. By default, the Netlify project to link will be automatically detected if exactly one project found is found with a matching git URL. If we cannot find such a project, you will be interactively prompted to select one.
1717

1818
**Usage**
1919

@@ -29,8 +29,8 @@ netlify clone
2929
**Flags**
3030

3131
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
32-
- `id` (*string*) - ID of existing Netlify site to link to
33-
- `name` (*string*) - Name of existing Netlify site to link to
32+
- `id` (*string*) - ID of existing Netlify project to link to
33+
- `name` (*string*) - Name of existing Netlify project to link to
3434
- `debug` (*boolean*) - Print debugging information
3535
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
3636

@@ -42,7 +42,7 @@ netlify clone https://github.com/vibecoder/next-unicorn.git
4242
netlify clone git@github.com:vibecoder/next-unicorn.git
4343
netlify clone vibecoder/next-unicorn ./next-unicorn-shh-secret
4444
netlify clone --id 123-123-123-123 vibecoder/next-unicorn
45-
netlify clone --name my-site-name vibecoder/next-unicorn
45+
netlify clone --name my-project-name vibecoder/next-unicorn
4646
```
4747

4848

docs/commands/deploy.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Deploys from the build settings found in the netlify.toml file, or settings from
1313
The following environment variables can be used to override configuration file lookups and prompts:
1414

1515
- `NETLIFY_AUTH_TOKEN` - an access token to use when authenticating commands. Keep this value private.
16-
- `NETLIFY_SITE_ID` - override any linked site in the current working directory.
16+
- `NETLIFY_SITE_ID` - override any linked project in the current working directory.
1717

1818
Lambda functions in the function folder can be in the following configurations for deployment:
1919

@@ -91,22 +91,22 @@ netlify deploy
9191
- `functions` (*string*) - Specify a functions folder to deploy
9292
- `json` (*boolean*) - Output deployment data as JSON
9393
- `message` (*string*) - A short message to include in the deploy log
94-
- `no-build` (*boolean*) - Do not run build command before deploying. Only use this if you have no need for a build or your site has already been built.
95-
- `open` (*boolean*) - Open site after deploy
94+
- `no-build` (*boolean*) - Do not run build command before deploying. Only use this if you have no need for a build or your project has already been built.
95+
- `open` (*boolean*) - Open project after deploy
9696
- `prod-if-unlocked` (*boolean*) - Deploy to production if unlocked, create a draft otherwise
9797
- `debug` (*boolean*) - Print debugging information
9898
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
9999
- `prod` (*boolean*) - Deploy to production
100-
- `site` (*string*) - A site name or ID to deploy to
100+
- `site` (*string*) - A project name or ID to deploy to
101101
- `skip-functions-cache` (*boolean*) - Ignore any functions created as part of a previous `build` or `deploy` commands, forcing them to be bundled again as part of the deployment
102102
- `timeout` (*string*) - Timeout to wait for deployment to finish
103-
- `trigger` (*boolean*) - Trigger a new build of your site on Netlify without uploading local files
103+
- `trigger` (*boolean*) - Trigger a new build of your project on Netlify without uploading local files
104104

105105
**Examples**
106106

107107
```bash
108108
netlify deploy
109-
netlify deploy --site my-first-site
109+
netlify deploy --site my-first-project
110110
netlify deploy --no-build # Deploy without running a build first
111111
netlify deploy --prod
112112
netlify deploy --prod --open

docs/commands/env.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
title: Netlify CLI env command
33
sidebar:
44
label: env
5-
description: Control environment variables for the current site
5+
description: Control environment variables for the current project
66
---
77

88
# `env`
99

1010
<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
11-
Control environment variables for the current site
11+
Control environment variables for the current project
1212

1313
**Usage**
1414

@@ -24,10 +24,10 @@ netlify env
2424

2525
| Subcommand | description |
2626
|:--------------------------- |:-----|
27-
| [`env:clone`](/commands/env#envclone) | Clone environment variables from one site to another |
27+
| [`env:clone`](/commands/env#envclone) | Clone environment variables from one project to another |
2828
| [`env:get`](/commands/env#envget) | Get resolved value of specified environment variable (includes netlify.toml) |
2929
| [`env:import`](/commands/env#envimport) | Import and set environment variables from .env file |
30-
| [`env:list`](/commands/env#envlist) | Lists resolved environment variables for site (includes netlify.toml) |
30+
| [`env:list`](/commands/env#envlist) | Lists resolved environment variables for project (includes netlify.toml) |
3131
| [`env:set`](/commands/env#envset) | Set value of environment variable |
3232
| [`env:unset`](/commands/env#envunset) | Unset an environment variable which removes it from the UI |
3333

@@ -40,13 +40,13 @@ netlify env:get VAR_NAME
4040
netlify env:set VAR_NAME value
4141
netlify env:unset VAR_NAME
4242
netlify env:import fileName
43-
netlify env:clone --to <to-site-id>
43+
netlify env:clone --to <to-project-id>
4444
```
4545

4646
---
4747
## `env:clone`
4848

49-
Clone environment variables from one site to another
49+
Clone environment variables from one project to another
5050

5151
**Usage**
5252

@@ -58,16 +58,16 @@ netlify env:clone
5858

5959
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
6060
- `force` (*boolean*) - Bypasses prompts & Force the command to run.
61-
- `from` (*string*) - Site ID (From)
62-
- `to` (*string*) - Site ID (To)
61+
- `from` (*string*) - Project ID (From)
62+
- `to` (*string*) - Project ID (To)
6363
- `debug` (*boolean*) - Print debugging information
6464
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
6565

6666
**Examples**
6767

6868
```bash
69-
netlify env:clone --to <to-site-id>
70-
netlify env:clone --to <to-site-id> --from <from-site-id>
69+
netlify env:clone --to <to-project-id>
70+
netlify env:clone --to <to-project-id> --from <from-project-id>
7171
```
7272

7373
---
@@ -129,7 +129,7 @@ netlify env:import
129129
---
130130
## `env:list`
131131

132-
Lists resolved environment variables for site (includes netlify.toml)
132+
Lists resolved environment variables for project (includes netlify.toml)
133133

134134
**Usage**
135135

docs/commands/functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Run netlify dev locally
99

1010
<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
1111
Manage netlify functions
12-
The `functions` command will help you manage the functions in this site
12+
The `functions` command will help you manage the functions in this project
1313

1414
**Usage**
1515

docs/commands/init.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
title: Netlify CLI init command
33
sidebar:
44
label: init
5-
description: Initialize a new site locally
5+
description: Initialize a new project locally
66
---
77

88
# `init`
99

1010
<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
11-
Configure continuous deployment for a new or existing site. To create a new site without continuous deployment, use `netlify sites:create`
11+
Configure continuous deployment for a new or existing project. To create a new project without continuous deployment, use `netlify sites:create`
1212

1313
**Usage**
1414

@@ -19,7 +19,7 @@ netlify init
1919
**Flags**
2020

2121
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
22-
- `force` (*boolean*) - Reinitialize CI hooks if the linked site is already configured to use CI
22+
- `force` (*boolean*) - Reinitialize CI hooks if the linked project is already configured to use CI
2323
- `git-remote-name` (*string*) - Name of Git remote to use. e.g. "origin"
2424
- `manual` (*boolean*) - Manually configure a git remote for CI
2525
- `debug` (*boolean*) - Print debugging information

docs/commands/link.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
title: Netlify CLI link command
33
sidebar:
44
label: link
5-
description: Link an existing site to a local site directory
5+
description: Link an existing project to a local project directory
66
---
77

88
# `link`
99

1010
<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
11-
Link a local repo or project folder to an existing site on Netlify
11+
Link a local repo or project folder to an existing project on Netlify
1212

1313
**Usage**
1414

@@ -21,8 +21,8 @@ netlify link
2121
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
2222
- `git-remote-name` (*string*) - Name of Git remote to use. e.g. "origin"
2323
- `git-remote-url` (*string*) - URL of the repository (or Github `owner/repo`) to link to
24-
- `id` (*string*) - ID of site to link to
25-
- `name` (*string*) - Name of site to link to
24+
- `id` (*string*) - ID of project to link to
25+
- `name` (*string*) - Name of project to link to
2626
- `debug` (*boolean*) - Print debugging information
2727
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
2828

@@ -31,7 +31,7 @@ netlify link
3131
```bash
3232
netlify link
3333
netlify link --id 123-123-123-123
34-
netlify link --name my-site-name
34+
netlify link --name my-project-name
3535
netlify link --git-remote-url https://github.com/vibecoder/my-unicorn.git
3636
```
3737

docs/commands/logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77
# `logs`
88

99
<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
10-
Stream logs from your site
10+
Stream logs from your project
1111

1212
**Usage**
1313

docs/commands/open.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77
# `open`
88

99
<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
10-
Open settings for the site linked to the current folder
10+
Open settings for the project linked to the current folder
1111

1212
**Usage**
1313

@@ -17,16 +17,16 @@ netlify open
1717

1818
**Flags**
1919

20-
- `admin` (*boolean*) - Open Netlify site
20+
- `admin` (*boolean*) - Open Netlify project
2121
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
22-
- `site` (*boolean*) - Open site
22+
- `site` (*boolean*) - Open project
2323
- `debug` (*boolean*) - Print debugging information
2424
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
2525

2626
| Subcommand | description |
2727
|:--------------------------- |:-----|
28-
| [`open:admin`](/commands/open#openadmin) | Opens current site admin UI in Netlify |
29-
| [`open:site`](/commands/open#opensite) | Opens current site url in browser |
28+
| [`open:admin`](/commands/open#openadmin) | Opens current project admin UI in Netlify |
29+
| [`open:site`](/commands/open#opensite) | Opens current project url in browser |
3030

3131

3232
**Examples**
@@ -41,7 +41,7 @@ netlify open:site
4141
---
4242
## `open:admin`
4343

44-
Opens current site admin UI in Netlify
44+
Opens current project admin UI in Netlify
4545

4646
**Usage**
4747

@@ -64,7 +64,7 @@ netlify open:admin
6464
---
6565
## `open:site`
6666

67-
Opens current site url in browser
67+
Opens current project url in browser
6868

6969
**Usage**
7070

docs/commands/serve.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Netlify CLI serve command
33
sidebar:
44
label: serve
55
description:
6-
Build the site for production and serve locally. This does not watch the code for changes, so if you need to rebuild
7-
your site then you must exit and run `serve` again.
6+
Build the project for production and serve locally. This does not watch the code for changes, so if you need to rebuild
7+
your project then you must exit and run `serve` again.
88
---
99

1010
# `serve`
1111

1212
<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->
13-
Build the site for production and serve locally. This does not watch the code for changes, so if you need to rebuild your site then you must exit and run `serve` again.
13+
Build the project for production and serve locally. This does not watch the code for changes, so if you need to rebuild your project then you must exit and run `serve` again.
1414

1515
**Usage**
1616

0 commit comments

Comments
 (0)