Revamp contribution guides (#1041)

* Hide old application graph page Signed-off-by: Reshma Abdul Rahim <[email protected]> * Update docs/content/concepts/why-radius/application-graph/index.md Signed-off-by: Reshma Abdul Rahim <[email protected]> * Revamp contribution guides Signed-off-by: Reshma Abdul Rahim <[email protected]> * Remove untracked changes * Remove untracked changes * Remove untracked changes * fix workspace switch cli example (#1029) Signed-off-by: Emanuel Palm <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> * Hide old application graph page Signed-off-by: Reshma Abdul Rahim <[email protected]> * Update docs/content/concepts/why-radius/application-graph/index.md Signed-off-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> * Revamp contribution guides Signed-off-by: Reshma Abdul Rahim <[email protected]> * Remove untracked changes Signed-off-by: Reshma Abdul Rahim <[email protected]> * Remove untracked changes Signed-off-by: Reshma Abdul Rahim <[email protected]> * Remove untracked changes Signed-off-by: Reshma Abdul Rahim <[email protected]> * Make community tope level Signed-off-by: Reshma Abdul Rahim <[email protected]> * Delete package-lock.json Signed-off-by: Reshma Abdul Rahim <[email protected]> * address feedback Signed-off-by: Reshma Abdul Rahim <[email protected]> * Update docs/content/contributing/overview/index.md Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> * Remove changes to package-lock.json Signed-off-by: Reshma Abdul Rahim <[email protected]> * Restore package-lock.json Signed-off-by: Reshma Abdul Rahim <[email protected]> * Resore package-lock.json Signed-off-by: Reshma Abdul Rahim <[email protected]> * Add aliase Signed-off-by: Reshma Abdul Rahim <[email protected]> * Address feedback Signed-off-by: Reshma Abdul Rahim <[email protected]> * Address feedback Signed-off-by: Reshma Abdul Rahim <[email protected]> --------- Signed-off-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Emanuel Palm <[email protected]> Co-authored-by: Emanuel Palm <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]>
radius-project · Feb 21, 2024 · 47e30c0 · 47e30c0
1 parent 246a32b
commit 47e30c0
Show file tree

Hide file tree

Showing 16 changed files with 63 additions and 65 deletions.
diff --git a/docs/content/community/_index.md b/docs/content/community/_index.md
@@ -3,5 +3,5 @@ type: docs
 title: "Radius Community"
 linkTitle: "Community"
 description: "Information about the Radius community"
-weight: 90
----
+weight: 120
+---
diff --git a/docs/content/community/contributing/github.md b/docs/content/community/contributing/github.md
diff --git a/docs/content/community/contributing/overview/index.md b/docs/content/community/contributing/overview/index.md
diff --git a/docs/content/community/maintainers/_index.md b/docs/content/community/maintainers/_index.md
diff --git a/docs/content/community/media-coverage.md → ...content/community/media-coverage/index.md b/docs/content/community/media-coverage.md → ...content/community/media-coverage/index.md
@@ -3,7 +3,7 @@ type: docs
 title: "Radius press coverage and media links"
 linkTitle: "Press/media coverage"
 description: "Learn about Radius through press articles, blog posts, presentation and other coverage of Radius"
-weight: 500
+weight: 200
 ---
 
 ## Blog posts

diff --git a/docs/content/community/overview.md → docs/content/community/overview/index.md b/docs/content/community/overview.md → docs/content/community/overview/index.md
@@ -18,14 +18,12 @@ The best way to interact with the community is via the Radius Discord server:
 
 Every month we host a community meeting to showcase new features, review upcoming milestones, and engage in a Q&A. Anyone from the Radius community can participate, present a topic, or host. All are welcome! For the meeting schedule, links, and more information, visit the Radius [community repo](https://github.com/radius-project/community#community-meetings).
 
-## GitHub Issues & repositories
-
-If you would like to file Issues, access the source code, or use Codespaces please visit the [Radius GitHub repo](https://github.com/radius-project).
-
 ## How can I get involved?
 
 One of the easiest ways to contribute is to participate in discussions at community engagements or via the Discord server referenced above. We are always seeking feedback, especially for suggestions around improving the product and docs.
 
+If you are interested in contributing to the Radius project, please visit the [Contributing to Radius]({{< ref contributing >}}) page for more information.
+
 ## Press and media coverage
 
 Visit the [press and media coverage docs]({{< ref media-coverage >}}) for a list of press articles, blog posts, presentations, and other coverage of Radius.
diff --git a/.../content/community/contributing/_index.md → docs/content/contributing/_index.md b/.../content/community/contributing/_index.md → docs/content/contributing/_index.md
@@ -3,5 +3,5 @@ type: docs
 title: "Contributing to Radius"
 linkTitle: "Contributing"
 description: "Guides and requirements for contributing to Radius"
-weight: 200
+weight: 110
 ---
diff --git a/docs/content/contributing/docs/_index.md b/docs/content/contributing/docs/_index.md
@@ -0,0 +1,7 @@
+---
+type: docs
+title: "Radius Docs"
+linkTitle: "Docs"
+description: "Learn how to contribute and maintain the Radius documentation"
+weight: 300
+---
diff --git a/...t/community/contributing/architecture.png → ...ontent/contributing/docs/architecture.png b/...t/community/contributing/architecture.png → ...ontent/contributing/docs/architecture.png
diff --git a/...ntributing/contributing-docs/diataxis.png → ...uting/docs/contributing-docs/diataxis.png b/...ntributing/contributing-docs/diataxis.png → ...uting/docs/contributing-docs/diataxis.png
diff --git a/...y/contributing/contributing-docs/index.md → ...tributing/docs/contributing-docs/index.md b/...y/contributing/contributing-docs/index.md → ...tributing/docs/contributing-docs/index.md
@@ -3,8 +3,8 @@ type: docs
 title: "How-To: Contribute to the Radius documentation"
 linkTitle: "Contribute to docs"
 description: "How to contribute to the Radius documentation"
-weight: 200
-slug: "docs"
+weight: 100
+aliases  : ["/community/contributing/docs/"]
 ---
 
 The Radius docs are built on [Hugo](https://gohugo.io) with the [Docsy](https://docsy.dev) theme. GitHub Actions are used to build and deploy the docs upon each PR.

diff --git a/...community/maintainers/docs-maintainers.md → ...ntributing/docs/maintainers-docs/index.md b/...community/maintainers/docs-maintainers.md → ...ntributing/docs/maintainers-docs/index.md
@@ -4,6 +4,7 @@ title: "How-To: Maintain the Radius docs"
 linkTitle: "Maintain docs"
 weight: 200
 description: "Learn about the Radius docs maintenance process"
+aliases  : ["/community/maintainers/docs-maintainers/"]
 ---
 
 In this guide, you’ll learn how to perform routine Radius docs maintainer and approver responsibilities. In order to successfully accomplish these tasks, you need either approver or maintainer status in the [`radius-project/docs`](https://github.com/radius-project/docs) repo. 

diff --git a/docs/content/contributing/overview/index.md b/docs/content/contributing/overview/index.md
@@ -0,0 +1,36 @@
+---
+type: docs
+title: "Overview: Contributing to Radius"
+linkTitle: "Overview"
+description: "Guides and requirements for contributing to Radius"
+weight: 100
+aliases  : ["/community/contributing/overview"]
+---
+
+We welcome contributions to Radius! Contributions can come in different ways such as engaging with the community, contributing code, or improving the documentation. This page provides an overview of the different ways you can contribute to Radius.
+
+## Community
+
+Check out the [Radius Community]({{< ref community >}}) page to learn about the different ways you can engage with the Radius community.
+
+## GitHub
+
+If you would like to file Issues, access the source code, or use Codespaces please visit the [Radius GitHub repo](https://github.com/radius-project). 
+
+### good-first-issues
+
+To quickly get started with contributing to code on Radius, here are some identified [good-first-issues](https://aka.ms/radius-first-issues) that you can `/assign` to yourself and start contributing. 
+
+<a class="btn btn-primary" href="https://aka.ms/radius-first-issues" role="button" target="_blank">good-first-issues</a>
+
+### Contributing to Radius
+
+Check out the following table to learn where and how you can contribute:
+
+| Repository | Description | Contribution guides |
+|------------|-------------|---------------------|
+| **Radius** | Main repository that contains source code for [`rad` CLI]((https://github.com/radius-project/radius/blob/main/docs/contributing/contributing-code/contributing-code-cli/running-rad-cli.md)), [control plane]((https://github.com/radius-project/radius/blob/main/docs/contributing/contributing-code/contributing-code-control-plane/README.md)) and other components of Radius | [radius-project/radius](https://github.com/radius-project/radius/blob/main/CONTRIBUTING.md)|
+| **Docs** | Documentation for Radius | [radius-project/docs]({{< ref contributing-docs>}})|
+| **Recipes** | Commonly used [Recipe](https://docs.radapp.io/recipes) templates for Radius Environments | [radius-project/recipes](https://github.com/radius-project/recipes/blob/main/CONTRIBUTING.md) |(https://github.com/radius-project/recipes/blob/main/CONTRIBUTING.md) |
+| **Dashboard** | The frontend experience for Radius |[radius-project/dashboard](https://github.com/radius-project/dashboard/blob/main/CONTRIBUTING.md) |
+| **Bicep** |  Temporary fork of the [Bicep repo](https://github.com/azure/bicep) used to inject the Radius types into the Bicep language. Contains both the Bicep CLI and the Bicep VS Code extension. | [radius-project/bicep](https://github.com/radius-project/bicep/blob/radius-compiler/CONTRIBUTING.md) |
diff --git a/.../content/community/presentations/index.md → ...ntent/contributing/presentations/index.md b/.../content/community/presentations/index.md → ...ntent/contributing/presentations/index.md
@@ -4,6 +4,7 @@ title: "Give a Radius presentation"
 linkTitle: "Presentations"
 description: "Learn how to give a Radius presentation, with downloadable slides and assets"
 weight: 400
+aliases  : ["/community/presentations/"]
 ---
 
 We welcome community members giving presentations on Radius and spreading the word about all the awesome Radius features!

diff --git a/docs/content/reference/limitations.md b/docs/content/reference/limitations.md
@@ -128,3 +128,13 @@ Some of the [AWS resource types](/resource-schema/aws) are 'non-idempotent', thi
 We are currently building support for non-idempotent resources in Radius. Please like and comment on this [this issue](https://github.com/radius-project/radius/issues/6227) if you are interested in the same.
 
 As a workaround, you can try using [Terraform Recipes]({{< ref "/guides/recipes/overview" >}}) to deploy and manage those non-idempotent resource types.
+
+## GitHub
+
+### Visual Studio not authorized for single sign-on
+
+If you receive an error saying Visual Studio Code or another application is not authorized to clone any of the Radius repositories you may need to re-authorize the GitHub app:
+
+1. Open a browser to https://github.com/settings/applications
+1. Find the applicable app and select Revoke
+1. Reopen app on local machine and re-auth
diff --git a/docs/content/tutorials/eshop/_index.md b/docs/content/tutorials/eshop/_index.md
@@ -39,5 +39,3 @@ Adding Radius to the eShop on containers application allows teams to:
 - Simplify deployment with Bicep and Azure Resource Manager (ARM)
 
 {{< button text="View eShop sample" githubRepo="samples" githubPath="samples/eshop" color="success" size="btn-lg" >}}
-
-*Visit the [GitHub docs]({{< ref github >}}) if you need access to the organization*
Original file line number	Diff line number	Diff line change
Expand Up		@@ -39,5 +39,3 @@ Adding Radius to the eShop on containers application allows teams to:
		- Simplify deployment with Bicep and Azure Resource Manager (ARM)

		{{< button text="View eShop sample" githubRepo="samples" githubPath="samples/eshop" color="success" size="btn-lg" >}}

		Visit the [GitHub docs]({{< ref github >}}) if you need access to the organization