-
Notifications
You must be signed in to change notification settings - Fork 854
Europa documentation website #1327
Copy link
Copy link
Closed
Description
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?
- Learn CUE
- 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
- Shape of the new Europa docs #1568
- Europa docs - CI/CD in your local dev #1586 + Update Europa docs - CI/CD in your local dev to the new netlify.cue plan #1732
- Capture the first CI environments that we intend to document #1678
- Europa docs: From local dev to CI environment #1693
2/3. Core Concepts
- Add dagger.#Plan core concept to Europa Docs #1683 + Europa docs plan updates after Client API & dagger do #1735
- Interacting with the client (configuring inputs) Client API #1668
- How to use secrets Client API #1668
- [Docs] Building container images #1708
- Create your own package → starting point https://docs.dagger.io/1010/dev-cue-package/
- Make your builds fast - blocked on BuildKit caching cc @TomChv https://github.com/TomChv/buildkit-cache-test
3/3. Use Cases
- Elixir/Phoenix on Kubernetes
- Docusaurus on Netlify
- Go with GoReleaser
- Europa docs: Go on Docker Swarm #1602 (this is the pre-Europa version) -> https://docs.dagger.io/1211/go-docker-swarm/
- Svelte on Vercel
There are a few other tasks which need to be done part of this & are not related to content:
- Add link to Europa docs #1679
- Add a DRAFTS section to the Europa docs sidebar #1680
- Temporarily remove Use Cases from the Europa docs sidebar #1687 (will be added back post 0.2.0)
- Default docs to Europa #1742
- Fix pre-Europa API reference post 0.2.0
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels