Skip to content

Commit f445fc9

Browse files
jasonmccallisterVikram Vaswanijedevc
authored
docs: major restructure of the docs (dagger#10731)
* adding the basic layout and structure Signed-off-by: Jason McCallister <jason@mccallister.dev> * adding the structure and use cases Signed-off-by: Jason McCallister <jason@mccallister.dev> * setting up the paths Signed-off-by: Jason McCallister <jason@mccallister.dev> * add script to copy old snippets Signed-off-by: Jason McCallister <jason@mccallister.dev> * cleaning up Signed-off-by: Jason McCallister <jason@mccallister.dev> * going to try this Signed-off-by: Jason McCallister <jason@mccallister.dev> * cleaning up quickstart Signed-off-by: Jason McCallister <jason@mccallister.dev> * move content inline Signed-off-by: Jason McCallister <jason@mccallister.dev> * somewhat working Signed-off-by: Jason McCallister <jason@mccallister.dev> * working example Signed-off-by: Jason McCallister <jason@mccallister.dev> * cleaning up Signed-off-by: Jason McCallister <jason@mccallister.dev> * reorging Signed-off-by: Jason McCallister <jason@mccallister.dev> * working tab for system commands Signed-off-by: Jason McCallister <jason@mccallister.dev> * add working shell-tabs with state memory Signed-off-by: Jason McCallister <jason@mccallister.dev> * working on custom code group Signed-off-by: Jason McCallister <jason@mccallister.dev> * adding new component Signed-off-by: Jason McCallister <jason@mccallister.dev> * cleaning up Signed-off-by: Jason McCallister <jason@mccallister.dev> * system tabs Signed-off-by: Jason McCallister <jason@mccallister.dev> * first pass, moving snippets into one location - adding the basic structure Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove new_docs dir Signed-off-by: Jason McCallister <jason@mccallister.dev> * move api into extending, fix all the links Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix the regex Signed-off-by: Jason McCallister <jason@mccallister.dev> * update the sidebar Signed-off-by: Jason McCallister <jason@mccallister.dev> * reset styling, move content around Signed-off-by: Jason McCallister <jason@mccallister.dev> * reset styling and make a few tweaks Signed-off-by: Jason McCallister <jason@mccallister.dev> * cleaning up Signed-off-by: Jason McCallister <jason@mccallister.dev> * moving more snippets around getting objects setup Signed-off-by: Jason McCallister <jason@mccallister.dev> * add glossary Signed-off-by: Jason McCallister <jason@mccallister.dev> * update lock file Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix the cli path Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix the frontmatter Signed-off-by: Jason McCallister <jason@mccallister.dev> * set same version from main Signed-off-by: Jason McCallister <jason@mccallister.dev> * move more items around, fix build errors Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix the build by making empty sidebars Signed-off-by: Jason McCallister <jason@mccallister.dev> * small style changes and dark logo Signed-off-by: Jason McCallister <jason@mccallister.dev> * style changes Signed-off-by: Jason McCallister <jason@mccallister.dev> * better sidebar Signed-off-by: Jason McCallister <jason@mccallister.dev> * apply for light mode Signed-off-by: Jason McCallister <jason@mccallister.dev> * set hover for darkmode to match theme Signed-off-by: Jason McCallister <jason@mccallister.dev> * move integrations Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix sidebar Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove doc card list Signed-off-by: Jason McCallister <jason@mccallister.dev> * add the styling Signed-off-by: Jason McCallister <jason@mccallister.dev> * working on components section Signed-off-by: Jason McCallister <jason@mccallister.dev> * wording Signed-off-by: Jason McCallister <jason@mccallister.dev> * cleaning up Signed-off-by: Jason McCallister <jason@mccallister.dev> * rm Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix broken mdx component Signed-off-by: Jason McCallister <jason@mccallister.dev> * svg styling Signed-off-by: Jason McCallister <jason@mccallister.dev> * add markdownlint-cli as dev dep, add configuration pages Signed-off-by: Jason McCallister <jason@mccallister.dev> * rm worktree Signed-off-by: Jason McCallister <jason@mccallister.dev> * style and content changes Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix links Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove old slug Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix all the broken anchors Signed-off-by: Jason McCallister <jason@mccallister.dev> * change the node engine Signed-off-by: Jason McCallister <jason@mccallister.dev> * update deps Signed-off-by: Jason McCallister <jason@mccallister.dev> * straight 20 Signed-off-by: Jason McCallister <jason@mccallister.dev> * switch node types to 18 Signed-off-by: Jason McCallister <jason@mccallister.dev> * Use node 20 Signed-off-by: Jason McCallister <jason@mccallister.dev> * only set the bottom margin on desktop Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix title to label Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix titles to labels Signed-off-by: Jason McCallister <jason@mccallister.dev> * add cookbook, move into dedicated pages, custom applications Signed-off-by: Jason McCallister <jason@mccallister.dev> * cleaning up and splitting custom applications out Signed-off-by: Jason McCallister <jason@mccallister.dev> * cleaning up Signed-off-by: Jason McCallister <jason@mccallister.dev> * update sidebar, move monorepo Signed-off-by: Jason McCallister <jason@mccallister.dev> * add more terms Signed-off-by: Jason McCallister <jason@mccallister.dev> * moving items around for clarity Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix lint and new title with desc Signed-off-by: Jason McCallister <jason@mccallister.dev> * add .markdownlintignore Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix the paths in the markdownlintignore Signed-off-by: Jason McCallister <jason@mccallister.dev> * Update overview page Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update "what is dagger" section Signed-off-by: Vikram Vaswani <vikram@dagger.io> * update with new links Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove index page from features Signed-off-by: Jason McCallister <jason@mccallister.dev> * Add each example as partial Signed-off-by: Jason McCallister <jason@mccallister.dev> * wip partials and component Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove cookbook loader Signed-off-by: Jason McCallister <jason@mccallister.dev> * move snippets onto pages Signed-off-by: Jason McCallister <jason@mccallister.dev> * Style change Signed-off-by: Jason McCallister <jason@mccallister.dev> * add more aliases Signed-off-by: Jason McCallister <jason@mccallister.dev> * Improve features section Signed-off-by: Vikram Vaswani <vikram@dagger.io> * moving imports to global scope Signed-off-by: Jason McCallister <jason@mccallister.dev> * beter darkmode support for flowcharts Signed-off-by: Jason McCallister <jason@mccallister.dev> * moving things around Signed-off-by: Jason McCallister <jason@mccallister.dev> * change environment to env, prefix partials with _ Signed-off-by: Jason McCallister <jason@mccallister.dev> * move types into partials Signed-off-by: Jason McCallister <jason@mccallister.dev> * add missing types as partials and cookbook examples Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix syntax issue on partial Signed-off-by: Jason McCallister <jason@mccallister.dev> * changes to sidebar, inline content and ite,s Signed-off-by: Jason McCallister <jason@mccallister.dev> * reorder the integrations about components Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix some sidebar length issues, content changes Signed-off-by: Jason McCallister <jason@mccallister.dev> * more content changes and linking Signed-off-by: Jason McCallister <jason@mccallister.dev> * Dagger module -> Dagger Module Signed-off-by: Jason McCallister <jason@mccallister.dev> * Signed-off-by: Jason McCallister <jason@mccallister.dev> * add another item Signed-off-by: Jason McCallister <jason@mccallister.dev> * update Signed-off-by: Jason McCallister <jason@mccallister.dev> * Signed-off-by: Jason McCallister <jason@mccallister.dev> * splitting runtime and platform Signed-off-by: Jason McCallister <jason@mccallister.dev> * add openshift Signed-off-by: Jason McCallister <jason@mccallister.dev> * styling Signed-off-by: Jason McCallister <jason@mccallister.dev> * reorg based on feedback, update links Signed-off-by: Jason McCallister <jason@mccallister.dev> * move things around Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix copypasta Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix links Signed-off-by: Jason McCallister <jason@mccallister.dev> * add missing schema and sdk references Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove chart Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix nav after changes Signed-off-by: Jason McCallister <jason@mccallister.dev> * Add the github stars to the nav Signed-off-by: Jason McCallister <jason@mccallister.dev> * style changes for tablets, smaller top nav Signed-off-by: Jason McCallister <jason@mccallister.dev> * small styling tweaks for ipad and iphone Signed-off-by: Jason McCallister <jason@mccallister.dev> * more minor style tweaks Signed-off-by: Jason McCallister <jason@mccallister.dev> * add missing heading Signed-off-by: Jason McCallister <jason@mccallister.dev> * add partials for build cookbook, move use cases Signed-off-by: Jason McCallister <jason@mccallister.dev> * Change nesting of types sections Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Remove livestreams page Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add missing pages Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add use cases Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update use cases Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix incomplete links Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Remove redundant sidebar labels Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix conflicts Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix quickstarts nav Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * updated text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Change labels in sidebar Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated labels Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update extending intro content Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update extending overview page Signed-off-by: Vikram Vaswani <vikram@dagger.io> * better type pages Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix broken link Signed-off-by: Jason McCallister <jason@mccallister.dev> * add more brand colors to accent navigation Signed-off-by: Jason McCallister <jason@mccallister.dev> * small style tweaks Signed-off-by: Jason McCallister <jason@mccallister.dev> * add missing client sdk page Signed-off-by: Jason McCallister <jason@mccallister.dev> * highlight private vs public Signed-off-by: Jason McCallister <jason@mccallister.dev> * Add "adopting" page Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fixed conflicts, moved more best practices Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add missing module structure content Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated links Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add examples and code snippets for envs and agents Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fixed links Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add container env example Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add env with directory snippet Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add agent example Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix slug Signed-off-by: Vikram Vaswani <vikram@dagger.io> * remove some old pages Signed-off-by: Jason McCallister <jason@mccallister.dev> * move troubleshooting under the first sidebar item Signed-off-by: Jason McCallister <jason@mccallister.dev> * add api internals Signed-off-by: Jason McCallister <jason@mccallister.dev> * add api overview page Signed-off-by: Jason McCallister <jason@mccallister.dev> * Make sidebar category label consistent Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Make terminology consistent Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add missing page Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add missing sidebar Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated sidebar label Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Remove goreleaser from example list Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add CacheVolume,GitRepository types Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Remove API overview reference page Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Improve directory type page Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix conflicts Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Restructure getting started nav Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix links Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fixed bullets and indentation in some cookbook sections Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Adjusted nav for getting started and extending sections Signed-off-by: Vikram Vaswani <vikram@dagger.io> * small changes and cleanup Signed-off-by: Jason McCallister <jason@mccallister.dev> * partials should have _ prefixed Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove bold formatting Signed-off-by: Jason McCallister <jason@mccallister.dev> * Update the content Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove bullets Signed-off-by: Jason McCallister <jason@mccallister.dev> * Lowercase 'type' and 'module' Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add FAQ link Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Remove demos pags Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add CI pages to left menu Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Reduce usage of "core type" Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Remove redundant overview pages and merge caching page Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Rename code page to examples and adjust nav Signed-off-by: Vikram Vaswani <vikram@dagger.io> * remove bold links Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix links and sidebar Signed-off-by: Jason McCallister <jason@mccallister.dev> * faq changes, style tweaks Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove the banner Signed-off-by: Jason McCallister <jason@mccallister.dev> * remove hypens Signed-off-by: Jason McCallister <jason@mccallister.dev> * add discord icon in header and footer Signed-off-by: Jason McCallister <jason@mccallister.dev> * Fix case Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add Apple container to install page, update text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Propose changes to style guide Signed-off-by: Vikram Vaswani <vikram@dagger.io> * ci: disable docs republish for next release Signed-off-by: Justin Chadwell <me@jedevc.com> * Fix URL paths Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update examples page Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add links to container runtime reference pages Signed-off-by: Vikram Vaswani <vikram@dagger.io> * fix typescript linting Signed-off-by: Jason McCallister <jason@mccallister.dev> * python formatting Signed-off-by: Jason McCallister <jason@mccallister.dev> * formatting Signed-off-by: Jason McCallister <jason@mccallister.dev> * python fixes Signed-off-by: Jason McCallister <jason@mccallister.dev> * fix broken links Signed-off-by: Jason McCallister <jason@mccallister.dev> * correct syntax issues for typescript Signed-off-by: Jason McCallister <jason@mccallister.dev> * python lint errors Signed-off-by: Jason McCallister <jason@mccallister.dev> * don't nest to fix links Signed-off-by: Jason McCallister <jason@mccallister.dev> * better description Signed-off-by: Jason McCallister <jason@mccallister.dev> * add playground and instructions for running locally Signed-off-by: Jason McCallister <jason@mccallister.dev> --------- Signed-off-by: Jason McCallister <jason@mccallister.dev> Signed-off-by: Jason McCallister <jason@dagger.io> Signed-off-by: Vikram Vaswani <vikram@dagger.io> Signed-off-by: Justin Chadwell <me@jedevc.com> Co-authored-by: Vikram Vaswani <vikram@dagger.io> Co-authored-by: Justin Chadwell <me@jedevc.com>
1 parent b264263 commit f445fc9

1,684 files changed

Lines changed: 32758 additions & 7778 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/.dagger/main.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ type Docs struct {
3838

3939
const (
4040
generatedSchemaPath = "docs/docs-graphql/schema.graphqls"
41-
generatedCliZenPath = "docs/current_docs/reference/cli.mdx"
41+
generatedCliZenPath = "docs/current_docs/reference/cli/index.mdx"
4242
generatedAPIReferencePath = "docs/static/api/reference/index.html"
4343
generatedDaggerJSONSchemaPath = "docs/static/reference/dagger.schema.json"
4444
generatedEngineJSONSchemaPath = "docs/static/reference/engine.schema.json"
@@ -52,12 +52,10 @@ const (
5252
)
5353

5454
const cliZenFrontmatter = `---
55-
slug: /reference/cli/
56-
pagination_next: null
57-
pagination_prev: null
55+
title: "CLI Reference"
56+
description: "Learn how to use the Dagger CLI to run composable workflows in containers."
5857
---
5958
60-
# CLI Reference
6159
`
6260

6361
// Build the docs website
@@ -98,6 +96,7 @@ func (d Docs) Lint(ctx context.Context) (rerr error) {
9896
From("tmknom/markdownlint:"+markdownlintVersion).
9997
WithMountedDirectory("/src", d.Source).
10098
WithMountedFile("/src/.markdownlint.yaml", d.Source.File(".markdownlint.yaml")).
99+
WithMountedFile("/src/.markdownlintignore", d.Source.File("docs/.markdownlintignore")).
101100
WithWorkdir("/src").
102101
WithExec([]string{
103102
"markdownlint",

docs/.markdownlintignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
docs/archived_docs/*
2+
docs/current_docs/reference/typescript/*
3+
docs/node_modules/*

docs/STYLE_GUIDE.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
</Tabs>
3434
```
3535

36-
- Always capitalize Dagger core types such as `Container`, `Secret`, etc
36+
- Always capitalize and use code font for Dagger core types such as `Container`, `Secret`, etc
3737
- Omit the `()` for readability since a lot of the time it's either not necessary, or implies no args are needed, and sometimes you just want to refer to a method call and ignore its required args e.g. `Container.asService`
3838
- Dagger Functions and arguments in code listings should be documented inline "wherever possible", except for Cookbook recipes where this is "mandatory" since these are intended to be best-practice examples. This inline documentation includes at minimum
3939
- a one-line comment for the function
@@ -59,7 +59,13 @@
5959

6060
- When writing lists, use a hyphen `-` for unordered lists and a number followed by a period `1.` for ordered lists
6161
- Lists should not end with a period
62-
- Keywords, features, concepts in the lists should be bolded followed by `:` (e.g. `**State and duration**: Get visual cues for cached and pending states, and see exactly how long each step of your workflow takes (including accounting for lazy effects installed by a Dagger Function).`)
62+
- List lead-ins or labels followed by a colon (`:`) should be in bold text e.g. `**State and duration**: Get visual cues for cached and pending states, and see exactly how long each step of your workflow takes.`
63+
64+
## Formatting styles
65+
66+
- Body text should not use bold, italic or other formatting styles except in the following cases:
67+
- List lead-ins or labels should use bold text (see `Lists` section)
68+
- User interface labels should use bold text e.g. `Click the **Start** button.`
6369

6470
## Cookbook
6571

0 commit comments

Comments
 (0)