Updating contribution docs #8212

kachawla · 2025-01-08T23:08:36Z

Description

Remove/hide GitHub Codespaces until it can be re-enabled on the repo.
Add a link to running control plane locally in how to learn guides.
Minor formatting fix.

Type of change

This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).

Fixes: #issue_number

Contributor checklist

Please verify that the PR meets the following requirements, where applicable:

[N/A] An overview of proposed schema changes is included in a linked GitHub issue.
[N/A] A design document PR is created in the design-notes repository, if new APIs are being introduced.
[N/A] If applicable, design document has been reviewed and approved by Radius maintainers/approvers.
[N/A ] A PR for the samples repository is created, if existing samples are affected by the changes in this PR.
[N/A] A PR for the documentation repository is created, if the changes in this PR affect the documentation or any user facing updates are made.
[N/A] A PR for the recipes repository is created, if existing recipes are affected by the changes in this PR.

radius-functional-tests · 2025-01-08T23:15:56Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	kachawla/radius
Commit ref	`52ae0bd`
Unique ID	funcc16c70b814
Image tag	pr-funcc16c70b814

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

gotestsum 1.12.0
KinD: v0.20.0
Dapr:
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-funcc16c70b814
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-funcc16c70b814
dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-funcc16c70b814
controller test image location: ghcr.io/radius-project/dev/controller:pr-funcc16c70b814
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-funcc16c70b814
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 ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

codecov · 2025-01-08T23:19:52Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.75%. Comparing base (73ed52d) to head (248fa75).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8212   +/-   ##
=======================================
  Coverage   59.75%   59.75%           
=======================================
  Files         590      590           
  Lines       39487    39487           
=======================================
  Hits        23597    23597           
  Misses      14146    14146           
  Partials     1744     1744

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

...ting/contributing-code/contributing-code-first-commit/first-commit-00-prerequisites/index.md

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

Signed-off-by: Karishma Chawla <kachawla@microsoft.com>

radius-functional-tests · 2025-01-09T00:46:35Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	kachawla/radius
Commit ref	`a5b182d`
Unique ID	func36ce08eb90
Image tag	pr-func36ce08eb90

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

gotestsum 1.12.0
KinD: v0.20.0
Dapr:
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func36ce08eb90
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-func36ce08eb90
dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-func36ce08eb90
controller test image location: ghcr.io/radius-project/dev/controller:pr-func36ce08eb90
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func36ce08eb90
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 ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

Signed-off-by: Karishma Chawla <kachawla@microsoft.com>

radius-functional-tests · 2025-01-09T02:33:31Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	kachawla/radius
Commit ref	`248fa75`
Unique ID	func910aadeb91
Image tag	pr-func910aadeb91

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

gotestsum 1.12.0
KinD: v0.20.0
Dapr:
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func910aadeb91
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-func910aadeb91
dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-func910aadeb91
controller test image location: ghcr.io/radius-project/dev/controller:pr-func910aadeb91
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func910aadeb91
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 ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

kachawla requested review from a team as code owners January 8, 2025 23:08

kachawla temporarily deployed to publish-bicep January 8, 2025 23:08 — with GitHub Actions Inactive

kachawla requested a review from willtsai January 8, 2025 23:09

kachawla temporarily deployed to functional-tests January 8, 2025 23:15 — with GitHub Actions Inactive

kachawla temporarily deployed to publish-bicep January 9, 2025 00:01 — with GitHub Actions Inactive

nithyatsu reviewed Jan 9, 2025

View reviewed changes

...ting/contributing-code/contributing-code-first-commit/first-commit-00-prerequisites/index.md Outdated Show resolved Hide resolved

nithyatsu reviewed Jan 9, 2025

View reviewed changes

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

Updating contribution docs

3f51776

Signed-off-by: Karishma Chawla <kachawla@microsoft.com>

kachawla force-pushed the contribution-doc-updates branch from c707f75 to a5b182d Compare January 9, 2025 00:45

kachawla temporarily deployed to publish-bicep January 9, 2025 00:45 — with GitHub Actions Inactive

kachawla temporarily deployed to functional-tests January 9, 2025 00:45 — with GitHub Actions Inactive

kachawla force-pushed the contribution-doc-updates branch from a5b182d to d35f8d4 Compare January 9, 2025 01:57

kachawla temporarily deployed to publish-bicep January 9, 2025 02:00 — with GitHub Actions Inactive

Minor updates

248fa75

Signed-off-by: Karishma Chawla <kachawla@microsoft.com>

kachawla force-pushed the contribution-doc-updates branch from d35f8d4 to 248fa75 Compare January 9, 2025 02:18

kachawla temporarily deployed to publish-bicep January 9, 2025 02:18 — with GitHub Actions Inactive

kachawla temporarily deployed to functional-tests January 9, 2025 02:32 — with GitHub Actions Inactive

nithyatsu approved these changes Jan 9, 2025

View reviewed changes

kachawla merged commit 546d69a into radius-project:main Jan 9, 2025
29 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating contribution docs #8212

Updating contribution docs #8212

kachawla commented Jan 8, 2025

radius-functional-tests bot commented Jan 8, 2025 •

edited

Loading

codecov bot commented Jan 8, 2025 •

edited

Loading

radius-functional-tests bot commented Jan 9, 2025 •

edited

Loading

radius-functional-tests bot commented Jan 9, 2025 •

edited

Loading

Updating contribution docs #8212

Updating contribution docs #8212

Conversation

kachawla commented Jan 8, 2025

Description

Type of change

Contributor checklist

radius-functional-tests bot commented Jan 8, 2025 • edited Loading

Radius functional test overview

Test Status

codecov bot commented Jan 8, 2025 • edited Loading

Codecov Report

radius-functional-tests bot commented Jan 9, 2025 • edited Loading

Radius functional test overview

Test Status

radius-functional-tests bot commented Jan 9, 2025 • edited Loading

Radius functional test overview

Test Status

radius-functional-tests bot commented Jan 8, 2025 •

edited

Loading

codecov bot commented Jan 8, 2025 •

edited

Loading

radius-functional-tests bot commented Jan 9, 2025 •

edited

Loading

radius-functional-tests bot commented Jan 9, 2025 •

edited

Loading