Skip to content

Europa documentation website #1327

@shykes

Description

@shykes

Overview

The Europa release introduces major changes, which will require new documentation. This issue is a placeholder for tracking work on these new docs.

Topics to consider include:

  • New user experience: command-line syntax, getting started, operator manual
  • New developer experience: APIs, programming concepts, sample code
  • Migration from earlier versions
  • New positioning. When we wrote the current documentation, Dagger was positioned more broadly and vaguely. Now, it is positioned as a portable devkit for CICD. The positioning emphasizes specific benefits and features. The structure of the docs should reflect that.
  • Navigate the Universe. A crucial feature of Dagger is the Universe: a large and growing collection of reusable code. The experience of navigating Universe should be crucial to the design of our docs.
  • Getting started tutorial

Content map

Here is a map of the content to write, organized in a rough structure. Work in progress. This is a placeholder for discussion and planning.

  • Getting started
  • Guides
    • Learn CUE
      • Dagger for frontend development
      • Dagger for MLops
      • Dagger for backend development
      • CUE 101: the basics
      • Intermediate CUE: multi-line strings
      • Intermediate CUE: …
      • Advanced CUE: …
      • Advanced CUE: …
    • Testing your DAG
    • Managing secrets with Dagger
    • Dagger for local development
      • Using local directories
      • Connecting to local network services
    • Building Docker containers with Dagger
    • Integrating Dagger in your CI
    • Deploying review environments with Dagger
    • Buildkit administrator guide
      • Buildkit with Docker
      • Buildkit clustering
      • Multi-architecture with buildkit
      • Buildkit no AWS: the dream setup
      • Dedicated buildkit or embedded buildkit?
  • Use cases
    • Developer Dagger with Dagger
    • How changelog.com improved its CICD with Dagger
    • How Particubes deploys its documentation faster with Dagger

Delivery plan

There are 3 parts to this. We will focus on 1 & 2 for 0.2.0, and continue with 3 without blocking the 0.2.0 release.

1/3. Getting Started

2/3. Core Concepts

3/3. Use Cases

There are a few other tasks which need to be done part of this & are not related to content:

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions