added back comments to satisfy docs

Signed-off-by: Richard Jones <richard@dagger.io>
This commit is contained in:
Richard Jones 2021-12-17 11:55:28 -07:00
parent 07862714af
commit 7a4ed586d7
No known key found for this signature in database
GPG Key ID: CFB3A382EB166F4C
6 changed files with 25 additions and 49 deletions

View File

@ -19,10 +19,12 @@
- [dagger/op](./dagger/op.md) - op: low-level operations for Dagger processing pipelines - [dagger/op](./dagger/op.md) - op: low-level operations for Dagger processing pipelines
- [docker](./docker/README.md) - Docker container operations - [docker](./docker/README.md) - Docker container operations
- [docker/compose](./docker/compose.md) - Docker-compose operations - [docker/compose](./docker/compose.md) - Docker-compose operations
- [europa/dagger](./europa/dagger/README.md) - The Dagger API. - [europa/dagger](./europa/dagger/README.md) - -
- [europa/dagger/engine](./europa/dagger/engine/README.md) - - - [europa/dagger/engine](./europa/dagger/engine/README.md) - -
- [europa/dagger/engine/spec](./europa/dagger/engine/spec/README.md) - Placeholder package, to keep docs generating tool happy. - [europa/dagger/engine/spec](./europa/dagger/engine/spec/README.md) - Placeholder package, to keep docs generating tool happy.
- [europa/dagger/engine/spec/engine](./europa/dagger/engine/spec/engine.md) - HTTP operations - [europa/dagger/engine/spec/engine](./europa/dagger/engine/spec/engine.md) - The Dagger API.
HTTP operations
- [gcp](./gcp/README.md) - Google Cloud Platform - [gcp](./gcp/README.md) - Google Cloud Platform
- [gcp/cloudrun](./gcp/cloudrun.md) - - - [gcp/cloudrun](./gcp/cloudrun.md) - -
- [gcp/gcr](./gcp/gcr.md) - Google Container Registry - [gcp/gcr](./gcp/gcr.md) - Google Container Registry

View File

@ -4,8 +4,6 @@ sidebar_label: dagger
# alpha.dagger.io/europa/dagger # alpha.dagger.io/europa/dagger
The Dagger API.
```cue ```cue
import "alpha.dagger.io/europa/dagger" import "alpha.dagger.io/europa/dagger"
``` ```
@ -72,7 +70,7 @@ _No output._
## dagger.#Stream ## dagger.#Stream
A reference to a stream of bytes, for example: - The standard output or error stream of a command - The standard input stream of a command - The contents of a file or named pipe A stream of bytes
### dagger.#Stream Inputs ### dagger.#Stream Inputs

View File

@ -8,40 +8,6 @@ sidebar_label: engine
import "alpha.dagger.io/europa/dagger/engine" import "alpha.dagger.io/europa/dagger/engine"
``` ```
## engine.#CacheDir
A (best effort) persistent cache dir
### engine.#CacheDir Inputs
_No input._
### engine.#CacheDir Outputs
_No output._
## engine.#Context
### engine.#Context Inputs
_No input._
### engine.#Context Outputs
_No output._
## engine.#Exec
Execute a command in a container
### engine.#Exec Inputs
_No input._
### engine.#Exec Outputs
_No output._
## engine.#FS ## engine.#FS
A reference to a filesystem tree. For example: - The root filesystem of a container - A source code repository - A directory containing binary artifacts Rule of thumb: if it fits in a tar archive, it fits in a #FS. A reference to a filesystem tree. For example: - The root filesystem of a container - A source code repository - A directory containing binary artifacts Rule of thumb: if it fits in a tar archive, it fits in a #FS.

View File

@ -4,6 +4,8 @@ sidebar_label: engine
# alpha.dagger.io/europa/dagger/engine/spec/engine # alpha.dagger.io/europa/dagger/engine/spec/engine
The Dagger API.
HTTP operations HTTP operations
```cue ```cue
@ -34,16 +36,6 @@ _No input._
_No output._ _No output._
## engine.#Context
### engine.#Context Inputs
_No input._
### engine.#Context Outputs
_No output._
## engine.#Copy ## engine.#Copy
### engine.#Copy Inputs ### engine.#Copy Inputs
@ -64,6 +56,18 @@ _No input._
_No output._ _No output._
## engine.#DAG
A special kind of program which `dagger` can execute.
### engine.#DAG Inputs
_No input._
### engine.#DAG Outputs
_No output._
## engine.#Exec ## engine.#Exec
Execute a command in a container Execute a command in a container

View File

@ -4,4 +4,8 @@ import (
"alpha.dagger.io/europa/dagger/engine/spec/engine" "alpha.dagger.io/europa/dagger/engine/spec/engine"
) )
// A deployment plan executed by `dagger up`
#Plan: engine.#Plan #Plan: engine.#Plan
// A special kind of program which `dagger` can execute.
#DAG: engine.#DAG

View File

@ -26,6 +26,8 @@ import (
// - An HTTPS endpoint // - An HTTPS endpoint
#Service: engine.#Service #Service: engine.#Service
// A stream of bytes
#Stream: engine.#Stream #Stream: engine.#Stream
// A network service address
#Address: engine.#Address #Address: engine.#Address