Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup of the docs folder and Contributing #5619

Merged
merged 1 commit into from
Jun 2, 2023

Conversation

rynowak
Copy link
Contributor

@rynowak rynowak commented May 31, 2023

Description

This PR is a major overhaul of the content in our docs folder. I found some loose threads as part of this work so I pulled on them, which is why there are so many changes.

Major changes:

  • Reorganize of docs/contributing
  • Rewrite of contributing.md
  • Lots of NEW content (how to contribute, how to file issues, how to file pull requests, how to work on tests)
  • Lots of old/unused cruft removed

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • Code compiles correctly
  • Adds necessary unit tests for change
  • Adds necessary E2E tests for change
  • Unit tests passing
  • Extended the documentation / Created issue for it

Auto-generated summary

🤖 Generated by Copilot at c827e68

Summary

🔧📚🔒

This pull request removes unused or outdated files, enables authentication for the RP service, improves the contributor documentation, and fixes some build and debug issues. It also adds a new file with instructions on how to build the code and containers.

install target cleansed
Contributor docs improved
debug conflict solved

Walkthrough

  • Removed unnecessary and conflicting files from the project (link, link, link, link, link, link, link, link, link, link, link, link, link). These files were either replaced by new ones, deprecated by design decisions, or irrelevant to the current scope of the project.

@rynowak rynowak requested a review from a team as a code owner May 31, 2023 21:13
@rynowak
Copy link
Contributor Author

rynowak commented May 31, 2023

/cc @AaronCrawfis @vinayada1

Makefile Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented May 31, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref c827e68
Unique ID 5998bf8b31
Image tag pr-5998bf8b31
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-5998bf8b31
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-5998bf8b31
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-5998bf8b31

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 samples functional tests...
⌛ Starting ucp functional tests...
✅ samples functional tests succeeded
⌛ Starting corerp functional tests...
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented May 31, 2023

Test Results

2 748 tests  ±0   2 741 ✔️ ±0   1m 56s ⏱️ -1s
   242 suites ±0          7 💤 ±0 
       1 files   ±0          0 ±0 

Results for commit 4db4a9b. ± Comparison against base commit 2228304.

This pull request removes 2 and adds 2 tests. Note that renamed tests count towards both.
github.com/project-radius/radius/pkg/armrpc/frontend/controller ‑ TestValidateEtag_IfMatch/3ead4c9e-c77d-4a95-a87a-70db9d46cace
github.com/project-radius/radius/pkg/armrpc/frontend/controller ‑ TestValidateEtag_IfMatch/3ead4c9e-c77d-4a95-a87a-70db9d46cace#01
github.com/project-radius/radius/pkg/armrpc/frontend/controller ‑ TestValidateEtag_IfMatch/0888bae6-950f-4fc7-9f22-225d0d5bdb02
github.com/project-radius/radius/pkg/armrpc/frontend/controller ‑ TestValidateEtag_IfMatch/0888bae6-950f-4fc7-9f22-225d0d5bdb02#01

♻️ This comment has been updated with latest results.

@github-actions
Copy link

64.7

For the detailed report, please go to Checks tab, click Build and Test, and then download unit_test_coverage artifact at the bottom of build page.

  • Your PR branch coverage: 64.7 %
  • main branch coverage: 64.7 %
  • diff coverage: 0 %

The coverage result does not include the functional test coverage.

@rynowak rynowak force-pushed the rynowak/cleanup-contributing branch from c827e68 to 8c0c98d Compare May 31, 2023 21:35
@github-actions
Copy link

github-actions bot commented May 31, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 8c0c98d
Unique ID f690a8fbad
Image tag pr-f690a8fbad
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-f690a8fbad
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-f690a8fbad
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-f690a8fbad

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 samples functional tests...
✅ samples functional tests succeeded
⌛ Starting corerp functional tests...
⌛ Starting ucp functional tests...
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

64.7

For the detailed report, please go to Checks tab, click Build and Test, and then download unit_test_coverage artifact at the bottom of build page.

  • Your PR branch coverage: 64.7 %
  • main branch coverage: 64.7 %
  • diff coverage: 0 %

The coverage result does not include the functional test coverage.

docs/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ytimocin ytimocin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I grammarlied the PR :) other than the comments I left, LGTM...

docs/contributing/contributing-issues/README.md Outdated Show resolved Hide resolved
docs/contributing/contributing-pull-requests/README.md Outdated Show resolved Hide resolved
docs/contributing/contributing-pull-requests/README.md Outdated Show resolved Hide resolved
docs/contributing/contributing-pull-requests/README.md Outdated Show resolved Hide resolved
docs/contributing/contributing-releases/READMD.md Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 03e4c8d
Unique ID a80a512541
Image tag pr-a80a512541
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-a80a512541
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-a80a512541
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-a80a512541

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 samples functional tests...
⌛ Starting corerp functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 25d448f
Unique ID 2744dc0e23
Image tag pr-2744dc0e23
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-2744dc0e23
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-2744dc0e23
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-2744dc0e23

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 samples functional tests...
⌛ Starting corerp functional tests...
⌛ Starting ucp functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 3d6beb1
Unique ID 00a7a8a684
Image tag pr-00a7a8a684
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-00a7a8a684
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-00a7a8a684
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-00a7a8a684

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 corerp functional tests...
⌛ Starting samples functional tests...
⌛ Starting ucp functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 468006f
Unique ID 1315dfe724
Image tag pr-1315dfe724
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-1315dfe724
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-1315dfe724
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-1315dfe724

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 functional tests...
⌛ Starting samples functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 9c891aa
Unique ID 9c6410497a
Image tag pr-9c6410497a
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-9c6410497a
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-9c6410497a
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-9c6410497a

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 samples functional tests...
⌛ Starting corerp functional tests...
⌛ Starting ucp functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
❌ corerp functional test failed. Please check the logs for more details

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref e95aa21
Unique ID cc50c3260a
Image tag pr-cc50c3260a
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-cc50c3260a
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-cc50c3260a
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-cc50c3260a

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 functional tests...
⌛ Starting corerp functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 0f7e064
Unique ID 1d8275e2e8
Image tag pr-1d8275e2e8
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-1d8275e2e8
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-1d8275e2e8
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-1d8275e2e8

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 corerp functional tests...
⌛ Starting ucp functional tests...
⌛ Starting samples functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

This PR is a major overhaul of the content in our docs folder. I found some loose threads as part of this work so I pulled on them, which is why there are so many changes.

Major changes:

- Reorganize of docs/contributing
- Rewrite of contributing.md
- Lots of NEW content (how to contribute, how to file issues, how to file pull requests, how to work on tests)
- Lots of old/unused cruft removed
@rynowak rynowak force-pushed the rynowak/cleanup-contributing branch from b5572c1 to 4db4a9b Compare June 2, 2023 01:34
@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 629cbeb
Unique ID 09b6cbcd30
Image tag pr-09b6cbcd30
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-09b6cbcd30
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-09b6cbcd30
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-09b6cbcd30

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 functional tests...
⌛ Starting corerp functional tests...
⌛ Starting samples functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref b5572c1
Unique ID a290840f20
Image tag pr-a290840f20
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-a290840f20
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-a290840f20
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-a290840f20

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 corerp functional tests...
⌛ Starting ucp functional tests...
⌛ Starting samples functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 4db4a9b
Unique ID 2e04466305
Image tag pr-2e04466305
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-2e04466305
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-2e04466305
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-2e04466305

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 functional tests...
⌛ Starting corerp functional tests...
⌛ Starting samples functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

64.9

For the detailed report, please go to Checks tab, click Build and Test, and then download unit_test_coverage artifact at the bottom of build page.

  • Your PR branch coverage: 64.9 %
  • main branch coverage: 64.9 %
  • diff coverage: 0 %

The coverage result does not include the functional test coverage.

@rynowak rynowak closed this Jun 2, 2023
@rynowak rynowak reopened this Jun 2, 2023
@rynowak
Copy link
Contributor Author

rynowak commented Jun 2, 2023

Getting a linter failure I haven't seen before, so retrying tests. I'm trying to repro locally, I don't believe my PR caused this.

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 4db4a9b
Unique ID 5ff7e15ca8
Image tag pr-5ff7e15ca8
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-5ff7e15ca8
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-5ff7e15ca8
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-5ff7e15ca8

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 functional tests...
⌛ Starting samples functional tests...
⌛ Starting corerp functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

64.9

For the detailed report, please go to Checks tab, click Build and Test, and then download unit_test_coverage artifact at the bottom of build page.

  • Your PR branch coverage: 64.9 %
  • main branch coverage: 64.9 %
  • diff coverage: 0 %

The coverage result does not include the functional test coverage.

@rynowak rynowak closed this Jun 2, 2023
@rynowak rynowak reopened this Jun 2, 2023
@rynowak
Copy link
Contributor Author

rynowak commented Jun 2, 2023

One more time!

Previous failures caused by: golangci/golangci-lint#3877

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

Radius functional test overview

🔍 Go to test action run

Name Value
Repository project-radius/radius
Commit ref 4db4a9b
Unique ID 4936f05648
Image tag pr-4936f05648
Click here to see the list of tools in the current test run
  • KinD: v0.18.0
  • Dapr: 1.10.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.0.0
  • recipe location radiusdev.azurecr.io/test/functional/corerp/recipes/<name>:pr-4936f05648
  • appcore-rp test image location: radiusdev.azurecr.io/appcore-rp:pr-4936f05648
  • ucp test image location: radiusdev.azurecr.io/ucpd:pr-4936f05648

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 samples functional tests...
⌛ Starting ucp functional tests...
⌛ Starting corerp functional tests...
✅ samples functional tests succeeded
✅ ucp functional tests succeeded
✅ corerp functional tests succeeded

@github-actions
Copy link

github-actions bot commented Jun 2, 2023

64.9

For the detailed report, please go to Checks tab, click Build and Test, and then download unit_test_coverage artifact at the bottom of build page.

  • Your PR branch coverage: 64.9 %
  • main branch coverage: 64.9 %
  • diff coverage: 0 %

The coverage result does not include the functional test coverage.

@rynowak rynowak merged commit c3b94cc into main Jun 2, 2023
46 of 52 checks passed
@rynowak rynowak deleted the rynowak/cleanup-contributing branch June 2, 2023 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants