From 7a4ed586d74fd862a5efeae7bec7e4d446b23f8e Mon Sep 17 00:00:00 2001 From: Richard Jones Date: Fri, 17 Dec 2021 11:55:28 -0700 Subject: [PATCH] added back comments to satisfy docs Signed-off-by: Richard Jones --- docs/reference/README.md | 6 ++-- docs/reference/europa/dagger/README.md | 4 +-- docs/reference/europa/dagger/engine/README.md | 34 ------------------- .../europa/dagger/engine/spec/engine.md | 24 +++++++------ stdlib/europa/dagger/plan.cue | 4 +++ stdlib/europa/dagger/types.cue | 2 ++ 6 files changed, 25 insertions(+), 49 deletions(-) diff --git a/docs/reference/README.md b/docs/reference/README.md index b4b2aed8..39209ca1 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -19,10 +19,12 @@ - [dagger/op](./dagger/op.md) - op: low-level operations for Dagger processing pipelines - [docker](./docker/README.md) - Docker container 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/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/cloudrun](./gcp/cloudrun.md) - - - [gcp/gcr](./gcp/gcr.md) - Google Container Registry diff --git a/docs/reference/europa/dagger/README.md b/docs/reference/europa/dagger/README.md index 82a37e3a..dbec7284 100644 --- a/docs/reference/europa/dagger/README.md +++ b/docs/reference/europa/dagger/README.md @@ -4,8 +4,6 @@ sidebar_label: dagger # alpha.dagger.io/europa/dagger -The Dagger API. - ```cue import "alpha.dagger.io/europa/dagger" ``` @@ -72,7 +70,7 @@ _No output._ ## 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 diff --git a/docs/reference/europa/dagger/engine/README.md b/docs/reference/europa/dagger/engine/README.md index efa36fc0..29ecb74f 100644 --- a/docs/reference/europa/dagger/engine/README.md +++ b/docs/reference/europa/dagger/engine/README.md @@ -8,40 +8,6 @@ sidebar_label: 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 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. diff --git a/docs/reference/europa/dagger/engine/spec/engine.md b/docs/reference/europa/dagger/engine/spec/engine.md index a29168e8..676c6366 100644 --- a/docs/reference/europa/dagger/engine/spec/engine.md +++ b/docs/reference/europa/dagger/engine/spec/engine.md @@ -4,6 +4,8 @@ sidebar_label: engine # alpha.dagger.io/europa/dagger/engine/spec/engine +The Dagger API. + HTTP operations ```cue @@ -34,16 +36,6 @@ _No input._ _No output._ -## engine.#Context - -### engine.#Context Inputs - -_No input._ - -### engine.#Context Outputs - -_No output._ - ## engine.#Copy ### engine.#Copy Inputs @@ -64,6 +56,18 @@ _No input._ _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 Execute a command in a container diff --git a/stdlib/europa/dagger/plan.cue b/stdlib/europa/dagger/plan.cue index 223f6cd2..891174ea 100644 --- a/stdlib/europa/dagger/plan.cue +++ b/stdlib/europa/dagger/plan.cue @@ -4,4 +4,8 @@ import ( "alpha.dagger.io/europa/dagger/engine/spec/engine" ) +// A deployment plan executed by `dagger up` #Plan: engine.#Plan + +// A special kind of program which `dagger` can execute. +#DAG: engine.#DAG diff --git a/stdlib/europa/dagger/types.cue b/stdlib/europa/dagger/types.cue index b08dbeab..adf1cd32 100644 --- a/stdlib/europa/dagger/types.cue +++ b/stdlib/europa/dagger/types.cue @@ -26,6 +26,8 @@ import ( // - An HTTPS endpoint #Service: engine.#Service +// A stream of bytes #Stream: engine.#Stream +// A network service address #Address: engine.#Address