docs: update prerequiste and debug docs #6965

lechnerc77 · 2023-12-17T12:46:48Z

Description

This PR is a follow-up due to the introduction of dev containers and a new debugging configuration and updates the documentation with the new options. This comprises the:

setup prerequistes
fist commit - debugging

This includes the updates of dependent documentation in the "first-commit" directories if applicable.

Type of change

This pull request fixes a bug in Radius and has an approved issue (issue link required).

Linked to: #6923 (not closing it, as one more tak is open )

Auto-generated summary

copilot:all

Signed-off-by: Christian Lechner <[email protected]>

rynowak · 2023-12-18T17:11:33Z

...ting/contributing-code/contributing-code-first-commit/first-commit-04-debugging-cli/index.md

@@ -2,67 +2,76 @@

 ## Debugging your changes

-### Creating debug settings


I previewed this in GitHub to verify that all of the images still work. Looks good 👍

rynowak · 2023-12-18T17:14:35Z

...ting/contributing-code/contributing-code-first-commit/first-commit-04-debugging-cli/index.md


 You can play around with the various debugger features, like stepping into code. When you're done, hit the red square *stop* icon in the debugger tools to end the debugging session.

 ## Next step
+


This is great 👍

docs/contributing/contributing-code/contributing-code-prerequisites/README.md

rynowak · 2023-12-18T17:19:00Z

docs/contributing/contributing-code/contributing-code-prerequisites/README.md

+- [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go)
+
+Install both of these and then follow the steps in the *Quick Start* for the Go extension.
+


Can you put a small section here linking to the devcontainer setup? https://code.visualstudio.com/docs/devcontainers/tutorial

Done - added that in the dev container section in the beginning

rynowak · 2023-12-18T17:20:35Z

docs/contributing/contributing-code/contributing-code-prerequisites/README.md

+
+You can easily do this from the command shell with `code .`, which opens the current directory as a folder in VS Code.
+
+## Tool overview


I'd like to keep this section named Basic Prerequisites Some other docs pages refer to it by name.

docs/contributing/contributing-code/contributing-code-prerequisites/README.md

rynowak · 2023-12-18T17:21:36Z

docs/contributing/contributing-code/contributing-code-prerequisites/README.md

-  ```bash  
-  brew install make
-  ```
+- Make


Is there a reason to remove these instructions? We found mac users get stuck on this step.

In this section I kept the list of tools as an overview. The deatiled steps for installing make are described in the local setup. As I redone the outline based on your comments it is now again in the "old" place

docs/contributing/contributing-code/contributing-code-prerequisites/README.md

rynowak

Thanks @lechnerc77 - I think all of the new content and additions to the documentation are great 👍. I'd like to see if we can organize the prequisites page in a simpler way. See suggestion.

This is almost ready from my PoV.

…sites/README.md Co-authored-by: Ryan Nowak <[email protected]> Signed-off-by: Christian Lechner <[email protected]>

Signed-off-by: Christian Lechner <[email protected]>

lechnerc77 · 2023-12-19T07:05:15Z

@rynowak thanks for the review. I restructured the prerequisties README.md based on your comments. I think the flow is now more comprehensive for contributors. Looking forward to your feedback

rynowak · 2023-12-19T20:58:00Z

docs/contributing/contributing-code/contributing-code-prerequisites/README.md

+
+The dev container will be started automatically.
+
+    ![Dev container startup process](img/vscode-devcontainer-opening-process.png)


Not sure why but this is not rendering correctly. Here's what I see:

I had a wrong indentation in the markdown. This is fixed now

rynowak

This is looking awesome overall 👍

There's one more minor thing to fix: https://github.com/radius-project/radius/pull/6965/files#r1431932051

Signed-off-by: Christian Lechner <[email protected]>

lechnerc77 · 2023-12-20T06:40:48Z

This is looking awesome overall 👍

There's one more minor thing to fix: https://github.com/radius-project/radius/pull/6965/files#r1431932051

@rynowak Fixed the rendering issue (and one typo).

radius-functional-tests · 2023-12-20T15:19:34Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	lechnerc77/radius
Commit ref	`be803b8`
Unique ID	9d720e7efd
Image tag	pr-9d720e7efd

Click here to see the list of tools in the current test run

gotestsum 1.10.0
KinD: v0.20.0
Dapr: 1.12.0
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.1.0
Bicep recipe location ghcr.io/radius-project/dev/test/functional/shared/recipes/<name>:pr-9d720e7efd
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-9d720e7efd
controller test image location: ghcr.io/radius-project/dev/controller:pr-9d720e7efd
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-9d720e7efd
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting datastoresrp functional tests...
⌛ Starting daprrp functional tests...
⌛ Starting kubernetes functional tests...
⌛ Starting msgrp functional tests...
⌛ Starting samples functional tests...
⌛ Starting shared functional tests...
✅ ucp functional tests succeeded
✅ kubernetes functional tests succeeded
✅ msgrp functional tests succeeded
✅ samples functional tests succeeded
✅ daprrp functional tests succeeded
✅ shared functional tests succeeded

lechnerc77 added 4 commits December 17, 2023 11:41

docs: update prerequisite with dev container

a9bfd5f

Signed-off-by: Christian Lechner <[email protected]>

docs: update debug guide

e392d53

Signed-off-by: Christian Lechner <[email protected]>

docs: md linting and typos

8667df5

Signed-off-by: Christian Lechner <[email protected]>

docs: formatting of debig screenshots

908f9f9

Signed-off-by: Christian Lechner <[email protected]>

lechnerc77 requested review from a team as code owners December 17, 2023 12:46

lechnerc77 changed the title ~~docs: update prerequiste and beug docs~~ docs: update prerequiste and debug docs Dec 17, 2023

lechnerc77 mentioned this pull request Dec 17, 2023

Improvements to devcontainer #6923

Open

rynowak reviewed Dec 18, 2023

View reviewed changes

docs/contributing/contributing-code/contributing-code-prerequisites/README.md Outdated Show resolved Hide resolved

rynowak reviewed Dec 18, 2023

View reviewed changes

docs/contributing/contributing-code/contributing-code-prerequisites/README.md Outdated Show resolved Hide resolved

rynowak reviewed Dec 18, 2023

View reviewed changes

docs/contributing/contributing-code/contributing-code-prerequisites/README.md Show resolved Hide resolved

rynowak requested changes Dec 18, 2023

View reviewed changes

lechnerc77 and others added 4 commits December 18, 2023 19:02

Update docs/contributing/contributing-code/contributing-code-prerequi…

a3d41ec

…sites/README.md Co-authored-by: Ryan Nowak <[email protected]> Signed-off-by: Christian Lechner <[email protected]>

Update docs/contributing/contributing-code/contributing-code-prerequi…

afdc4ba

…sites/README.md Co-authored-by: Ryan Nowak <[email protected]> Signed-off-by: Christian Lechner <[email protected]>

Merge branch 'radius-project:main' into docs/get-started

e2fe994

docs: update structure after review

412241a

Signed-off-by: Christian Lechner <[email protected]>

rynowak reviewed Dec 19, 2023

View reviewed changes

rynowak requested changes Dec 19, 2023

View reviewed changes

docs: fix image rendering

be803b8

Signed-off-by: Christian Lechner <[email protected]>

rynowak approved these changes Dec 20, 2023

View reviewed changes

lechnerc77 temporarily deployed to functional-tests December 20, 2023 15:19 — with GitHub Actions Inactive

rynowak merged commit 6f257bc into radius-project:main Dec 20, 2023
16 checks passed

lechnerc77 deleted the docs/get-started branch December 21, 2023 08:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update prerequiste and debug docs #6965

docs: update prerequiste and debug docs #6965

lechnerc77 commented Dec 17, 2023

rynowak Dec 18, 2023

rynowak Dec 18, 2023

rynowak Dec 18, 2023

lechnerc77 Dec 19, 2023 •

edited

Loading

rynowak Dec 18, 2023

lechnerc77 Dec 19, 2023

rynowak Dec 18, 2023

lechnerc77 Dec 19, 2023 •

edited

Loading

rynowak left a comment

lechnerc77 commented Dec 19, 2023

rynowak Dec 19, 2023

lechnerc77 Dec 20, 2023

rynowak left a comment

lechnerc77 commented Dec 20, 2023

radius-functional-tests bot commented Dec 20, 2023 •

edited

Loading

		@@ -2,67 +2,76 @@

		## Debugging your changes

		### Creating debug settings


		You can play around with the various debugger features, like stepping into code. When you're done, hit the red square stop icon in the debugger tools to end the debugging session.

		## Next step

		- [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go)

		Install both of these and then follow the steps in the Quick Start for the Go extension.


		You can easily do this from the command shell with `code .`, which opens the current directory as a folder in VS Code.

		## Tool overview


		The dev container will be started automatically.

		![Dev container startup process](img/vscode-devcontainer-opening-process.png)

docs: update prerequiste and debug docs #6965

docs: update prerequiste and debug docs #6965

Conversation

lechnerc77 commented Dec 17, 2023

Description

Type of change

Auto-generated summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lechnerc77 Dec 19, 2023 • edited Loading

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

lechnerc77 Dec 19, 2023 • edited Loading

Choose a reason for hiding this comment

rynowak left a comment

Choose a reason for hiding this comment

lechnerc77 commented Dec 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rynowak left a comment

Choose a reason for hiding this comment

lechnerc77 commented Dec 20, 2023

radius-functional-tests bot commented Dec 20, 2023 • edited Loading

Radius functional test overview

Test Status

lechnerc77 Dec 19, 2023 •

edited

Loading

lechnerc77 Dec 19, 2023 •

edited

Loading

radius-functional-tests bot commented Dec 20, 2023 •

edited

Loading