0.13 docs update: tutorials #4127

vvagaytsev · 2023-04-26T11:22:35Z

What this PR does / why we need it:
Addresses the tutorials part of #4067.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

docs/tutorials/your-first-project/1-initialize-a-project.md

Orzelius · 2023-04-26T11:27:57Z

docs/tutorials/your-first-project/1-initialize-a-project.md

-To initialize the project, we can use a helper command:
+To initialize the project use a helper command:


Orzelius · 2023-04-26T11:29:32Z

docs/tutorials/your-first-project/1-initialize-a-project.md

@@ -35,55 +38,68 @@ providers:

 We have one environment (`default`) and a single provider. We'll get back to this later.

-Next, let's create module configs for each of our two modules, starting with `backend`.
+[//]: # (TODO: `garden create action` is still under construction, update this section when the command is ready)


I think we could just skip implementing it and have simple configs here.

Agree, the command can wait. I'll change the tutorial to use explicit configuration code snippets for action definitions.

Changed this in 1bc2439

vvagaytsev · 2023-05-08T10:24:46Z

@Orzelius @Walther now this is ready for the second review round :)

Orzelius · 2023-05-08T10:29:13Z

would you mind updating the target branch, there are 5k+ line changes in this pr currently

vvagaytsev · 2023-05-08T10:37:51Z

would you mind updating the target branch, there are 5k+ line changes in this pr currently

Ah, sorry, my bad :) I've just updated it, thanks 👍

Orzelius

some nitty-pickies

docs/tutorials/your-first-project/1-initialize-a-project.md

Orzelius · 2023-05-08T12:10:30Z

docs/tutorials/your-first-project/1-initialize-a-project.md

+description: Frontend service container
+type: container
+
+# This defines an image to be used and refers the 'frontend' Build action defined above


I think this can be removed as it's explained above

Removed in e1230b7

docs/tutorials/your-first-project/1-initialize-a-project.md

Orzelius · 2023-05-08T12:12:17Z

docs/tutorials/your-first-project/1-initialize-a-project.md

+dependencies:
+  - deploy.backend
+
+# This block is necessary to deploy and expose the frontend application


I think this can be removed as it's explained above

Removed in e1230b7

docs/tutorials/your-first-project/1-initialize-a-project.md

Orzelius · 2023-05-08T12:14:07Z

docs/tutorials/your-first-project/3-deploy-and-test.md

+spec:
+  args: [ npm, test ]
+
+--- # the yaml separator is necessary to delimit different actions


No need to repeat the comment imo, just distracts from other more important ones

Removed in e1230b7

docs/tutorials/your-first-project/3-deploy-and-test.md

docs/tutorials/your-first-project/4-configure-your-project.md

Makes editing in IDE easier, no need to horizontally scroll the text.

Co-authored-by: Orzelius <[email protected]>

Use explicit configuration code snippets instead of references to a non-existing command.

Co-authored-by: Orzelius <[email protected]>

vvagaytsev · 2023-05-08T12:48:21Z

Thanks for the comments and improvement @Orzelius! Now everything has been addressed and applied. Please review again :)

Orzelius

All good from me! 🎸

vvagaytsev requested review from Walther and Orzelius April 26, 2023 11:22

vvagaytsev changed the title ~~0.13 docs update tutorials~~ 0.13 docs update: tutorials Apr 26, 2023

Orzelius reviewed Apr 27, 2023

View reviewed changes

vvagaytsev force-pushed the 0.13-docs-update-tutorials branch from 8e90761 to 27f3448 Compare May 8, 2023 09:55

vvagaytsev requested a review from Orzelius May 8, 2023 10:24

vvagaytsev changed the base branch from 0.13-create-actions-command to 0.13 May 8, 2023 10:37

Orzelius suggested changes May 8, 2023

View reviewed changes

vvagaytsev and others added 16 commits May 8, 2023 14:45

chore: formatting

ed830ae

Makes editing in IDE easier, no need to horizontally scroll the text.

chore: typofix

9122a23

docs: 0.13 docs update in tutorials (1)

59844fa

docs: 0.13 docs update for tutorials (2)

4229788

docs: 0.13 docs update for tutorials (3)

1485eae

Update docs/tutorials/your-first-project/1-initialize-a-project.md

0cb6429

Co-authored-by: Orzelius <[email protected]>

docs: add link to the actions guide

3790b15

docs: updated "Initialize a project" tutorial

06ff859

Use explicit configuration code snippets instead of references to a non-existing command.

Update docs/tutorials/your-first-project/1-initialize-a-project.md

b93b436

Co-authored-by: Orzelius <[email protected]>

Update docs/tutorials/your-first-project/1-initialize-a-project.md

4624037

Co-authored-by: Orzelius <[email protected]>

Update docs/tutorials/your-first-project/1-initialize-a-project.md

fc4c954

Co-authored-by: Orzelius <[email protected]>

Update docs/tutorials/your-first-project/1-initialize-a-project.md

877575f

Co-authored-by: Orzelius <[email protected]>

Update docs/tutorials/your-first-project/1-initialize-a-project.md

b3b323e

Co-authored-by: Orzelius <[email protected]>

Update docs/tutorials/your-first-project/3-deploy-and-test.md

36b4cc2

Co-authored-by: Orzelius <[email protected]>

Update docs/tutorials/your-first-project/4-configure-your-project.md

6e7c1a2

Co-authored-by: Orzelius <[email protected]>

docs: address cr comments

e1230b7

vvagaytsev force-pushed the 0.13-docs-update-tutorials branch from ec794f3 to e1230b7 Compare May 8, 2023 12:47

vvagaytsev requested a review from Orzelius May 8, 2023 12:48

Orzelius approved these changes May 8, 2023

View reviewed changes

vvagaytsev merged commit 0d3fadc into 0.13 May 8, 2023

vvagaytsev deleted the 0.13-docs-update-tutorials branch May 8, 2023 13:05

This was referenced May 11, 2023

0.13 log metadata #4232

Closed

0.13 rootless containers #4273

Closed

qsays mentioned this pull request Dec 7, 2023

[Snyk] Security upgrade knex from 0.19.3 to 0.21.13 qsays/garden#191

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

0.13 docs update: tutorials #4127

0.13 docs update: tutorials #4127

vvagaytsev commented Apr 26, 2023

Orzelius Apr 26, 2023

Orzelius Apr 26, 2023

vvagaytsev May 2, 2023

vvagaytsev May 8, 2023

vvagaytsev commented May 8, 2023

Orzelius commented May 8, 2023

vvagaytsev commented May 8, 2023

Orzelius left a comment

Orzelius May 8, 2023

vvagaytsev May 8, 2023

Orzelius May 8, 2023

vvagaytsev May 8, 2023

Orzelius May 8, 2023

vvagaytsev May 8, 2023

vvagaytsev commented May 8, 2023

Orzelius left a comment

		To initialize the project, we can use a helper command:
		To initialize the project use a helper command:

0.13 docs update: tutorials #4127

0.13 docs update: tutorials #4127

Conversation

vvagaytsev commented Apr 26, 2023

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

vvagaytsev commented May 8, 2023

Orzelius commented May 8, 2023

vvagaytsev commented May 8, 2023

Orzelius 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

vvagaytsev commented May 8, 2023

Orzelius left a comment

Choose a reason for hiding this comment