docs: ♻️ merge API Reference and Universe menu entries

Signed-off-by: jffarge <jf@dagger.io>
This commit is contained in:
jffarge
2021-09-08 15:19:19 +02:00
parent a0d133c998
commit a2088a09ac
41 changed files with 32 additions and 24 deletions

View File

@@ -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.