Merge pull request #953 from slumbering/docs-menu-refacto

docs: ♻️ merge API Reference and Universe menu entries

Makefile

@@ -59,11 +59,11 @@ install: dagger
 
 .PHONY: docs
 docs: dagger
-	./cmd/dagger/dagger doc --output ./docs/reference/universe --format md
+	./cmd/dagger/dagger doc --output ./docs/reference --format md
 
 .PHONY: docslint
 docslint: docs
-	@test -z "$$(git status -s . | grep -e "^ M"  | grep docs/reference/universe | cut -d ' ' -f3 | tee /dev/stderr)"
+	@test -z "$$(git status -s . | grep -e "^ M"  | grep docs/reference | cut -d ' ' -f3 | tee /dev/stderr)"
 
 .PHONY: web
 web:

docs/learn/1004-first-env.md

@@ -133,6 +133,7 @@ In Dagger terms, this component has two essential properties:
 Let's write the corresponding Cue code to a new file in our package:
 
 ```cue file=./tests/multibucket/source.cue title="todoapp/cue.mod/multibucket/source.cue"
+
 ```
 
 This code defines a component at the key `src` and specifies that it is both an artifact and an input.
@@ -142,12 +143,13 @@ This code defines a component at the key `src` and specifies that it is both an
 The second component of our plan is the Yarn package built from the app source code:
 
 ```cue file=./tests/multibucket/yarn.cue title="todoapp/cue.mod/multibucket/yarn.cue"
+
 ```
 
 Let's break it down:
 
 - `package multibucket`: this file is part of the multibucket package
-- `import ( "alpha.dagger.io/js/yarn" )`: import a package from the [Dagger Universe](../reference/universe/README.md).
+- `import ( "alpha.dagger.io/js/yarn" )`: import a package from the [Dagger Universe](../reference/README.md).
 - `app: yarn.#Package`: apply the `#Package` definition at the key `app`
 - `&`: also merge the following values at the same key...
 - `{ source: src }`: set the key `app.source` to the value of `src`. This snippet of code connects our two components, forming the first link in our DAG
@@ -161,12 +163,13 @@ _FIXME_: this section is not yet available because the [Amazon S3 package](https
 The third component of our plan is the Netlify site to which the app will be deployed:
 
 ```cue file=./tests/multibucket/netlify.cue title="todoapp/cue.mod/multibucket/netlify.cue"
+
 ```
 
 This component is very similar to the previous one:
 
 - We use the same package name as the other files
-- We import another package from the [Dagger Universe](../reference/universe/README.md).
+- We import another package from the [Dagger Universe](../reference/README.md).
 - `site: "netlify": site.#Netlify`: apply the `#Site` definition at the key `site.netlify`. Note the use of quotes to protect the key from name conflict.
 - `&`: also merge the following values at the same key...
 - `{ contents: app.build }`: set the key `site.netlify.contents` to the value of `app.build`. This line connects our components 2 and 3, forming the second link in our DAG.
@@ -174,14 +177,14 @@ This component is very similar to the previous one:
 ### Exploring a package documentation
 
 But wait: how did we know what fields were available in `yarn.#Package` and `netlify.#Site`?
-Answer: thanks to the `dagger doc` command, which prints the documentation of any package from [Dagger Universe](../reference/universe/README.md).
+Answer: thanks to the `dagger doc` command, which prints the documentation of any package from [Dagger Universe](../reference/README.md).
 
 ```shell
 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.
+You can also browse the [Dagger Universe](../reference/README.md) reference in the documentation.
 
 ## Setup the environment
 

docs/learn/1008-aws-cloudformation.md

@@ -18,7 +18,7 @@ The provisioning strategy detailed below follows S3 best practices. However, to
 
 #### Relays
 
-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/universe/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
 
@@ -59,11 +59,12 @@ The idea here is to follow best practices in [S3 buckets](https://docs.aws.amazo
 Create a file named `template.cue` and add the following configuration to it.
 
 ```cue file=./tests/cloudformation/template.cue title="todoapp/cloudformation/template.cue"
+
 ```
 
 ##### 2. Cloudformation relay
 
-As our plan relies on [Cloudformation's relay](../reference/universe/aws/cloudformation.md), let's dissect the expected inputs by gradually incorporating them into our plan.
+As our plan relies on [Cloudformation's relay](../reference/aws/cloudformation.md), let's dissect the expected inputs by gradually incorporating them into our plan.
 
 ```shell
 dagger doc alpha.dagger.io/aws/cloudformation
@@ -96,6 +97,7 @@ The config values are all part of the `aws` relay. Regarding this package, as yo
 Let's implement the first step, use the `aws.#Config` relay, and request its first inputs: the region to deploy and the AWS credentials.
 
 ```cue file=./tests/cloudformation/source-begin.cue title="todoapp/cloudformation/source.cue"
+
 ```
 
 This defines:
@@ -138,6 +140,7 @@ dagger up -e cloudformation # Try to run the plan. As expected, we encounter a f
 Now that we have the `config` definition properly configured, let's modify the Cloudformation one:
 
 ```cue file=./tests/cloudformation/source-end.cue title="todoapp/cloudformation/source.cue"
+
 ```
 
 This defines:
@@ -184,11 +187,11 @@ dagger input secret awsConfig.secretKey yourSecretKey -e cloudformation
 
 Finally ! We now have a working template ready to be used to provision S3 infrastructures. Let's deploy it:
 <Tabs
-  defaultValue="nd"
+defaultValue="nd"
-  values={[
+values={[
-    { label: 'Normal deploy', value: 'nd', },
+{ label: 'Normal deploy', value: 'nd', },
-    { label: 'Debug deploy', value: 'dd', },
+{ label: 'Debug deploy', value: 'dd', },
-  ]
+]
 }>
 <TabItem value="nd">
 
@@ -257,6 +260,7 @@ import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
 ```cue file=./tests/cloudformation/template/convert.cue title="todoapp/cloudformation/convert.cue"
+
 ```
 
 This defines:
@@ -300,6 +304,7 @@ rm cloudformation/convert.cue
 Open `cloudformation/template.cue` and append below elements with copied Cue definition of the JSON:
 
 ```cue file=./tests/cloudformation/template/template-begin.cue title="todoapp/cloudformation/template.cue"
+
 ```
 
 We're using the built-in `json.Marshal` function to convert CUE back to JSON, so Cloudformation still receives the same template.
@@ -315,11 +320,13 @@ Now that the template is defined in CUE, we can use the language to add more fle
 Let's define a re-usable `#Deployment` definition in `todoapp/cloudformation/deployment.cue`:
 
 ```cue file=./tests/cloudformation/template/deployment.cue title="todoapp/cloudformation/deployment.cue"
+
 ```
 
 `template.cue` can be rewritten as follows:
 
 ```cue file=./tests/cloudformation/template/template-end.cue title="todoapp/cloudformation/template.cue"
+
 ```
 
 Verify template
@@ -352,6 +359,7 @@ dagger query template -f text -e cloudformation
 Reimplement `source.cue`:
 
 ```cue file=./tests/cloudformation/source-end.cue title="todoapp/cloudformation/source.cue"
+
 ```
 
 And we can now deploy it:

docs/reference/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "API Reference",
+  "label": "Universe - API Reference",
   "position": 5,
   "collapsed": false
 }

docs/reference/universe/_category_.json

@@ -1,3 +0,0 @@
-{
-  "label": "Universe"
-}

docs/use-cases/1012-ci.md

@@ -22,7 +22,7 @@ Dagger is the perfect tool for CI workflows.
   frontend? The backend won't be built again.
 - **Composable & Reusable**. Define re-usable steps and [share](../learn/1010-dev-cue-package.md) them across all
   your projects. Or with the world. Dagger
-  ships with [dozens of re-usable components](../reference/universe/README.md)
+  ships with [dozens of re-usable components](../reference/README.md)
 
 ## Example
 
@@ -71,9 +71,9 @@ lint: os.#Container & {
 The configuration above defines:
 
 - **source** code of the project. More on this later.
-- **test** *task* which executes `go test` inside the source artifact
+- **test** _task_ which executes `go test` inside the source artifact
   using the `golang` Docker image
-- **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.
 
 Before we can execute the configuration, we need to set up the Dagger workspace and environment.
@@ -118,7 +118,7 @@ integration with GitHub easier.
 Dagger workflows scale really well with CI complexity.
 
 The following example illustrates how to test two different projects in the same
-repository: a *Node* frontend (located in *./frontend*) along with a *Go* backend (located in *./backend*).
+repository: a _Node_ frontend (located in _./frontend_) along with a _Go_ backend (located in _./backend_).
 
 From the project repository, update the file named `ci/main.cue` with the
 following configuration.
@@ -180,7 +180,7 @@ frontend: {
 Larger configurations can be split into multiple files, for example `backend.cue` and `frontend.cue`
 :::
 
-The configuration above defines a *frontend* and *backend* structure, each
+The configuration above defines a _frontend_ and _backend_ structure, each
 containing:
 
 - A **code** directory, defined as a subdirectory of **source**
@@ -199,5 +199,5 @@ $ dagger up
 `frontend.test` and `backend.test` are running in parallel since there are no
 dependencies between each other.
 
-If you were to make changes to the *./frontend* directory, only
+If you were to make changes to the _./frontend_ directory, only
 `frontend.test` will be executed.

website/netlify.toml

@@ -47,5 +47,5 @@ status = 200
 
 [[redirects]]
 from = "/reference"
-to = "/reference/universe/alpine"
+to = "/reference/alpine"
 status = 302