Merge pull request #1002 from talentedmrjones/docs-terminology
DOCS: Terminology replace workspace with project
This commit is contained in:
commit
2249eab15d
@ -89,13 +89,13 @@ Developing for Dagger takes place in a [Cue module](https://cuelang.org/docs/con
|
|||||||
If you are familiar with Go, Cue modules are directly inspired by Go modules.
|
If you are familiar with Go, Cue modules are directly inspired by Go modules.
|
||||||
Otherwise, don't worry: a Cue module is simply a directory with one or more Cue packages in it. For example, a Cue module has a `cue.mod` directory at its root.
|
Otherwise, don't worry: a Cue module is simply a directory with one or more Cue packages in it. For example, a Cue module has a `cue.mod` directory at its root.
|
||||||
|
|
||||||
This guide will use the same directory as the root of the Dagger workspace and the Cue module, but you can create your Cue module anywhere inside the Dagger workspace. In general, you won't have to worry about it at all. You will initialize a dagger workspace with the following command.
|
This guide will use the same directory as the root of the Dagger project and the Cue module, but you can create your Cue module anywhere inside the Dagger project. In general, you won't have to worry about it at all. You will initialize a dagger project with the following command.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
dagger init # Optional, already present in `todoapp`
|
dagger init # Optional, already present in `todoapp`
|
||||||
```
|
```
|
||||||
|
|
||||||
> In our case, `todoapp` already contains a workspace, so this step is optional.
|
> In our case, `todoapp` already contains a `.dagger` directory, so this step is optional.
|
||||||
|
|
||||||
### Create a Cue package
|
### Create a Cue package
|
||||||
|
|
||||||
|
@ -9,7 +9,7 @@ This tutorial illustrates how to use Dagger to build, push and deploy Docker ima
|
|||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
## Initialize a Dagger Workspace and Environment
|
## Initialize a Dagger Project and Environment
|
||||||
|
|
||||||
### (optional) Setup example app
|
### (optional) Setup example app
|
||||||
|
|
||||||
|
@ -80,7 +80,7 @@ a [kubeconfig](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfi
|
|||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
## Initialize a Dagger Workspace and Environment
|
## Initialize a Dagger Project and Environment
|
||||||
|
|
||||||
### (optional) Setup example app
|
### (optional) Setup example app
|
||||||
|
|
||||||
|
@ -20,7 +20,7 @@ The provisioning strategy detailed below follows S3 best practices. However, to
|
|||||||
|
|
||||||
The first thing to consider when developing a plan based on relays is to read their universe reference: it summarizes the expected inputs and their corresponding formats. [Here](../reference/aws/cloudformation.md) is the Cloudformation one.
|
The first thing to consider when developing a plan based on relays is to read their universe reference: it summarizes the expected inputs and their corresponding formats. [Here](../reference/aws/cloudformation.md) is the Cloudformation one.
|
||||||
|
|
||||||
## Initialize a Dagger Workspace and Environment
|
## Initialize a Dagger Project and Environment
|
||||||
|
|
||||||
### (optional) Setup example app
|
### (optional) Setup example app
|
||||||
|
|
||||||
|
@ -8,16 +8,16 @@ This tutorial illustrates how to create new packages, manually distribute them a
|
|||||||
|
|
||||||
## Creating your package
|
## Creating your package
|
||||||
|
|
||||||
### Initializing workspace
|
### Initializing project
|
||||||
|
|
||||||
Create an empty directory for your new Dagger workspace:
|
Create an empty directory for your new Dagger project:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
mkdir workspace
|
mkdir project
|
||||||
cd workspace
|
cd project
|
||||||
```
|
```
|
||||||
|
|
||||||
As described in the previous tutorials, initialize your Dagger workspace:
|
As described in the previous tutorials, initialize your Dagger project:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
dagger init
|
dagger init
|
||||||
@ -37,7 +37,7 @@ That will create two directories: `.dagger` and `cue.mod`, where our package wil
|
|||||||
|
|
||||||
### Writing the package
|
### Writing the package
|
||||||
|
|
||||||
Now that you've initialized your workspace, it's time to write a simple package. Package name usually starts with a
|
Now that you've initialized your project, it's time to write a simple package. Package name usually starts with a
|
||||||
domain name (as in Go) followed by a descriptive name. In this example, we reuse the Cloud Run example and create a
|
domain name (as in Go) followed by a descriptive name. In this example, we reuse the Cloud Run example and create a
|
||||||
package from it.
|
package from it.
|
||||||
|
|
||||||
@ -82,18 +82,18 @@ You should see a familiar output:
|
|||||||
|
|
||||||
## Manually distributing packages
|
## Manually distributing packages
|
||||||
|
|
||||||
You've probably guessed this package isn't tied to just your workspace. You can easily copy/paste it into any number
|
You've probably guessed this package isn't tied to just your project. You can easily copy/paste it into any number
|
||||||
of different workspaces and use it as we've shown above.
|
of different projects and use it as we've shown above.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
mkdir -p /my-new-workspace/cue.mod/pkg/github.com/tjovicic/gcpcloudrun
|
mkdir -p /my-new-project/cue.mod/pkg/github.com/tjovicic/gcpcloudrun
|
||||||
cp ./cue.mod/pkg/github.com/tjovicic/gcpcloudrun/source.cue /new-workspace/cue.mod/pkg/github.com/tjovicic/gcpcloudrun
|
cp ./cue.mod/pkg/github.com/tjovicic/gcpcloudrun/source.cue /new-project/cue.mod/pkg/github.com/tjovicic/gcpcloudrun
|
||||||
```
|
```
|
||||||
|
|
||||||
## Contributing to Dagger stdlib
|
## Contributing to Dagger stdlib
|
||||||
|
|
||||||
Our [stdlib](https://github.com/dagger/dagger/tree/main/stdlib) has many valuable packages that you can use.
|
Our [stdlib](https://github.com/dagger/dagger/tree/main/stdlib) has many valuable packages that you can use.
|
||||||
You've probably seen it when you've initialized your workspace:
|
You've probably seen it when you've initialized your project:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
.
|
.
|
||||||
|
@ -8,16 +8,16 @@ This tutorial illustrates how to install and upgrade packages using Dagger packa
|
|||||||
|
|
||||||
## Installing a package
|
## Installing a package
|
||||||
|
|
||||||
### Initializing workspace
|
### Initializing project
|
||||||
|
|
||||||
Create an empty directory for your new Dagger workspace:
|
Create an empty directory for your new Dagger project:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
mkdir workspace
|
mkdir project
|
||||||
cd workspace
|
cd project
|
||||||
```
|
```
|
||||||
|
|
||||||
As described in the previous tutorials, initialize your Dagger workspace:
|
As described in the previous tutorials, initialize your Dagger project:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
dagger init
|
dagger init
|
||||||
|
@ -84,10 +84,10 @@ The configuration above defines:
|
|||||||
- **lint** _task_ which executes `golangci-lint` inside the source artifact
|
- **lint** _task_ which executes `golangci-lint` inside the source artifact
|
||||||
using the `golangci-lint` Docker image.
|
using the `golangci-lint` Docker image.
|
||||||
|
|
||||||
Before we can execute the configuration, we need to set up the Dagger workspace and environment.
|
Before we can execute the configuration, we need to set up the Dagger project and environment.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# Initialize a dagger workspace at the root of your project
|
# Initialize a dagger project at the root of your project
|
||||||
dagger init
|
dagger init
|
||||||
|
|
||||||
# Create a CI environment using the CUE files in the `./ci` directory
|
# Create a CI environment using the CUE files in the `./ci` directory
|
||||||
|
Reference in New Issue
Block a user