From 539fa08ca13a02417111e8368c710236b358bcbf Mon Sep 17 00:00:00 2001 From: Andrea Luzzardi Date: Sun, 27 Jun 2021 15:07:52 +0200 Subject: [PATCH] docs: fix dagger.io->alpha.dagger.io references Fixes #733 Signed-off-by: Andrea Luzzardi --- docs/learn/102-dev.md | 4 +- docs/learn/107-kubernetes.md | 10 ++-- docs/learn/108-cloudformation.md | 4 +- docs/reference/universe/file.md | 84 -------------------------------- 4 files changed, 9 insertions(+), 93 deletions(-) delete mode 100644 docs/reference/universe/file.md diff --git a/docs/learn/102-dev.md b/docs/learn/102-dev.md index 8ece8a12..9310473c 100644 --- a/docs/learn/102-dev.md +++ b/docs/learn/102-dev.md @@ -205,8 +205,8 @@ But wait: how did we know what fields were available in `yarn.#Package` and `net Answer: thanks to the `dagger doc` command, which prints the documentation of any package from [Dagger Universe](../reference/universe/README.md). ```shell -dagger doc dagger.io/netlify -dagger doc dagger.io/js/yarn +dagger doc alpha.dagger.io/netlify +dagger doc alpha.dagger.io/js/yarn ``` You can also browse the [Dagger Universe](../reference/universe/README.md) reference in the documentation. diff --git a/docs/learn/107-kubernetes.md b/docs/learn/107-kubernetes.md index c617340a..8f86a96f 100644 --- a/docs/learn/107-kubernetes.md +++ b/docs/learn/107-kubernetes.md @@ -171,7 +171,7 @@ import ( // set with `dagger input text kubeconfig -f ~/.kube/config` kubeconfig: string @dagger(input) -// deploy uses the `dagger.io/kubernetes` package to apply a manifest to a +// deploy uses the `alpha.dagger.io/kubernetes` package to apply a manifest to a // Kubernetes cluster. deploy: kubernetes.#Resources & { // reference the `kubeconfig` input above @@ -199,7 +199,7 @@ gkeConfig: gke.#KubeConfig @dagger(input) kubeconfig: gkeConfig.kubeconfig -// deploy uses the `dagger.io/kubernetes` package to apply a manifest to a +// deploy uses the `alpha.dagger.io/kubernetes` package to apply a manifest to a // Kubernetes cluster. deploy: kubernetes.#Resources & { // reference the `kubeconfig` input above @@ -227,7 +227,7 @@ eksConfig: eks.#KubeConfig @dagger(input) kubeconfig: eksConfig.kubeconfig -// deploy uses the `dagger.io/kubernetes` package to apply a manifest to a +// deploy uses the `alpha.dagger.io/kubernetes` package to apply a manifest to a // Kubernetes cluster. deploy: kubernetes.#Resources & { // reference the `kubeconfig` input above @@ -245,7 +245,7 @@ This defines: - `kubeconfig` a _string_ **input**: kubernetes configuration (`~/.kube/config`) used for `kubectl` -- `deploy`: Deployment step using the package `dagger.io/kubernetes`. It takes +- `deploy`: Deployment step using the package `alpha.dagger.io/kubernetes`. It takes the `manifest` defined earlier and deploys it to the Kubernetes cluster specified in `kubeconfig`. ### Setup the environment @@ -578,7 +578,7 @@ The following configuration will: - Declare a `repository` input as a `dagger.#Artifact`. This will be mapped to the source code directory. - Declare a `registry` input. This is the address used for docker push -- Use `dagger.io/docker` to build and push the image +- Use `alpha.dagger.io/docker` to build and push the image - Use the registry image reference (`push.ref`) as the image for the deployment. ```cue title="todoapp/kube/manifest.cue" diff --git a/docs/learn/108-cloudformation.md b/docs/learn/108-cloudformation.md index 416f01e2..b5cf74b4 100644 --- a/docs/learn/108-cloudformation.md +++ b/docs/learn/108-cloudformation.md @@ -135,7 +135,7 @@ template: """ As our plan relies on [Cloudformation's relay](/reference/universe/aws/cloudformation), let's dissect the expected inputs by gradually incorporating them into our plan. ```shell -dagger doc dagger.io/aws/cloudformation +dagger doc alpha.dagger.io/aws/cloudformation # Inputs: # config.region string AWS region # config.accessKey dagger.#Secret AWS access key @@ -177,7 +177,7 @@ awsConfig: aws.#Config This defines: -- `awsConfig`: AWS CLI Configuration step using the package `dagger.io/aws`. It takes three user inputs: a `region`, an `accessKey`, and a `secretKey` +- `awsConfig`: AWS CLI Configuration step using the package `alpha.dagger.io/aws`. It takes three user inputs: a `region`, an `accessKey`, and a `secretKey` #### Setup the environment diff --git a/docs/reference/universe/file.md b/docs/reference/universe/file.md deleted file mode 100644 index d7be3274..00000000 --- a/docs/reference/universe/file.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_label: file ---- - -# dagger.io/file - -DEPRECATED: see dagger.io/os - -## #Append - -### #Append Inputs - -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*filename* | `string` |- | -|*permissions* | `*0o644 \| int` |- | -|*contents* | `(string\|bytes)` |- | -|*from* | `dagger.#Artifact` |- | - -### #Append Outputs - -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*orig* | `string` |- | - -## #Create - -### #Create Inputs - -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*filename* | `string` |- | -|*permissions* | `*0o644 \| int` |- | -|*contents* | `(string\|bytes)` |- | - -### #Create Outputs - -_No output._ - -## #Glob - -### #Glob Inputs - -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*glob* | `string` |- | -|*from* | `dagger.#Artifact` |- | - -### #Glob Outputs - -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*filenames* | `_\|_` |trim suffix because ls always ends with newline | -|*files* | `string` |- | - -## #Read - -### #Read Inputs - -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*filename* | `string` |- | -|*from* | `dagger.#Artifact` |- | - -### #Read Outputs - -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*contents* | `string` |- | - -## #read - -### #read Inputs - -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*path* | `string` |- | -|*from* | `dagger.#Artifact` |- | - -### #read Outputs - -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*data* | `string` |- |