docs: Revise quickstart with code-first approach redux #7382

vikram-dagger · 2024-05-14T19:24:54Z

This commit revises the quickstart to use an example application and build a pipeline for it by writing bespoke Dagger Functions.

Also see #7196 and #7275

Closes #7157

kpenfound · 2024-05-17T18:14:01Z

docs/current_docs/quickstart/snippets/refactor/go/main.go

+// Returns a directory with the production build
+func (m *HelloDagger) Build(source *Directory) *Directory {
+	return dag.Node(NodeOpts{Version: "21"}).
+		WithNpm().


I'll PR a new npm module + these content changes in a follow up PR. Lets get this merged like this first and worry about clean ups after! cc @shykes

vikram-dagger · 2024-05-20T11:02:18Z

Reviewers: I've created output GIFs using asciicinema. However because of the very long initialize time of appx 2-3m per snippet, I've cropped out those frames so that the user has to spend less time watching the timer. Please check if this is OK.

GIFs run at speed 6x, except the terminal, curl and docker run examples which are at 2x so they can be read clearly.

Noting also that generating the output GIFs required many manual adjustments and therefore was time-consuming. To be noted in case we change the TUI in future and need to regenerate these GIFs.

shykes

Incomplete review, will continue later...

shykes · 2024-05-20T18:51:41Z

docs/current_docs/quickstart/snippets/daggerize/go/main.go

+	return address, nil
+}
+
+// Returns a container with the production build and an NGINX service


Suggested change

// Returns a container with the production build and an NGINX service

// Build the application container

shykes · 2024-05-20T18:53:19Z

docs/current_docs/quickstart/snippets/daggerize/go/main.go

+
+type HelloDagger struct{}
+
+// Tests, builds and publishes the application


Suggested change

// Tests, builds and publishes the application

// Publish the application container after building and testing it on-the-fly

shykes · 2024-05-20T18:57:02Z

docs/current_docs/quickstart/snippets/daggerize/go/main.go

+		Stdout(ctx)
+}
+
+// Returns a container with the build environment


Suggested change

// Returns a container with the build environment

// Build a ready-to-use dev environment

shykes · 2024-05-20T18:58:06Z

docs/current_docs/quickstart/snippets/daggerize/go/main.go

+
+// Returns a container with the build environment
+func (m *HelloDagger) BuildEnv(source *Directory) *Container {
+	nodeCache := dag.CacheVolume("node")


@kpenfound @levlaz is there a risk that we encounter the same concurrency problem here than we did trying to build docusaurus in that livestream?

I think the risk is much lower because this is a much simpler example, I don't expect users to change inputs, and I don't expect users to run this concurrently.

shykes · 2024-05-20T20:53:28Z

docs/current_docs/quickstart/build.mdx

+dagger call \
+  build --source=.


Suggested change

dagger call \

build --source=.

dagger call build --source=.

When there's only one function in the chain, it looks simpler on a single line

shykes · 2024-05-20T20:54:38Z

docs/current_docs/quickstart/build.mdx

+
+Here's what you should see:
+
+![Final container](/img/current_docs/quickstart/build.gif)


I owe you a function to generate this. Sorry I didn't get to it, I didn't forget!

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

jpadams

There are some things we'll find post merge, but I think it's good enough to ship it!

docs/current_docs/quickstart/publish.mdx

marcosnils

Structure and text-wise LGTM to ship as a first iteration.

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

* Updated content Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Lint fixes Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated conclusion Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Lint fixes Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Remove guide Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated content Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated tips Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Copy edit Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Copy edit Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Copy edit Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Copy edit Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add feedback Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update conclusion Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update chaining example Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix lint Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix lint Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Move introductory content outside quickstart Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update conclusion, add links Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update copy Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add speedrun Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated copy Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated copy Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Added feedback Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Rewrite quickstart Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix links Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update content Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add code Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix lint errors Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update sidebar Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update quickstart Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update copy Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add second option Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update caching page copy Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update caching page copy Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update diagram Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Remove diagram Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Integrate feedback Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add images Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update code Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix linter Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix linter Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix linter Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix linter Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix linter Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update image Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix syntax Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Add feedback Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated chaining example and fixed error Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Fix linter Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update conclusion links Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update page link Signed-off-by: Vikram Vaswani <vikram@dagger.io> --------- Signed-off-by: Vikram Vaswani <vikram@dagger.io>

vikram-dagger marked this pull request as draft May 14, 2024 19:25

vikram-dagger mentioned this pull request May 15, 2024

docs: Revise quickstart with code-first approach #7326

Closed

vikram-dagger force-pushed the improve-qs-5 branch from 8cdd102 to aedadf5 Compare May 17, 2024 13:02

This comment was marked as resolved.

Sign in to view

kpenfound reviewed May 17, 2024

View reviewed changes

vikram-dagger force-pushed the improve-qs-5 branch from bed188b to aa89f2b Compare May 20, 2024 04:49

vikram-dagger marked this pull request as ready for review May 20, 2024 10:51

shykes reviewed May 20, 2024

View reviewed changes

vikram-dagger added 19 commits May 21, 2024 15:25

Updated content

7c24243

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Lint fixes

ffb4d43

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Updated conclusion

a278d56

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Lint fixes

17aba00

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Remove guide

4ecf93a

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Updated content

3bc50c0

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Updated tips

ef2d175

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Copy edit

bc24eee

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Copy edit

548148f

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Copy edit

3d8b279

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Copy edit

a588ccf

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Add feedback

af26d90

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update conclusion

970704a

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update chaining example

637cdff

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Fix lint

6871f2f

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Fix lint

2638cec

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Updated text

3c21272

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Move introductory content outside quickstart

341eb98

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update conclusion, add links

9ac5fbd

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

vikram-dagger added 19 commits May 21, 2024 15:25

Update quickstart

2b0d30a

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update copy

ce2c063

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Add second option

ca3fd29

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update caching page copy

f7e9608

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update caching page copy

609eea5

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update diagram

5738288

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Remove diagram

5117fbf

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Integrate feedback

d117b89

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Add images

870ce4b

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update code

d7fddb4

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Fix linter

6b28294

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Fix linter

1c62f7a

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Fix linter

25c2e52

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Fix linter

3fc2ba0

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Fix linter

df37135

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update text

01608ac

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update image

200b566

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update text

8fa0ac7

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Fix syntax

5fae2c5

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

vikram-dagger force-pushed the improve-qs-5 branch from 4a55d74 to 5fae2c5 Compare May 21, 2024 09:55

vikram-dagger added 3 commits May 21, 2024 15:33

Add feedback

26dd482

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Updated chaining example and fixed error

41308cf

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Fix linter

1389b74

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

jpadams approved these changes May 23, 2024

View reviewed changes

docs/current_docs/quickstart/publish.mdx Outdated Show resolved Hide resolved

marcosnils approved these changes May 23, 2024

View reviewed changes

vikram-dagger added 2 commits May 24, 2024 15:31

Update conclusion links

cc90157

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

Update page link

8bcff5f

Signed-off-by: Vikram Vaswani <vikram@dagger.io>

vikram-dagger merged commit 2bbdb09 into dagger:main May 24, 2024
59 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Revise quickstart with code-first approach redux #7382

docs: Revise quickstart with code-first approach redux #7382

vikram-dagger commented May 14, 2024 •

edited

This comment was marked as resolved.

kpenfound May 17, 2024

vikram-dagger commented May 20, 2024 •

edited

shykes left a comment

shykes May 20, 2024

vikram-dagger May 21, 2024

shykes May 20, 2024

vikram-dagger May 21, 2024

shykes May 20, 2024

vikram-dagger May 21, 2024

shykes May 20, 2024

levlaz May 20, 2024

shykes May 20, 2024

shykes May 20, 2024

vikram-dagger May 21, 2024

shykes May 20, 2024

jpadams left a comment

marcosnils left a comment

	// Returns a container with the production build and an NGINX service
	// Build the application container


		type HelloDagger struct{}

		// Tests, builds and publishes the application

	// Tests, builds and publishes the application
	// Publish the application container after building and testing it on-the-fly

	// Returns a container with the build environment
	// Build a ready-to-use dev environment


		Here's what you should see:

		![Final container](/img/current_docs/quickstart/build.gif)

docs: Revise quickstart with code-first approach redux #7382

docs: Revise quickstart with code-first approach redux #7382

Conversation

vikram-dagger commented May 14, 2024 • edited

This comment was marked as resolved.

Choose a reason for hiding this comment

vikram-dagger commented May 20, 2024 • edited

shykes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jpadams left a comment

Choose a reason for hiding this comment

marcosnils left a comment

Choose a reason for hiding this comment

vikram-dagger commented May 14, 2024 •

edited

vikram-dagger commented May 20, 2024 •

edited