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

Revamp contribution guides #1041

Merged
merged 31 commits into from
Feb 21, 2024
Merged
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
855d262
Hide old application graph page
Reshrahim Feb 6, 2024
3f61342
Update docs/content/concepts/why-radius/application-graph/index.md
Reshrahim Feb 6, 2024
0a8e601
Revamp contribution guides
Reshrahim Feb 9, 2024
92f7d2c
Remove untracked changes
Reshrahim Feb 9, 2024
cce5e53
Remove untracked changes
Reshrahim Feb 9, 2024
f5e1bb1
Remove untracked changes
Reshrahim Feb 9, 2024
f51a8c6
Merge branch 'v0.30' into v0.30
Reshrahim Feb 9, 2024
15f580b
fix workspace switch cli example (#1029)
PalmEmanuel Feb 2, 2024
f1056fd
Hide old application graph page
Reshrahim Feb 6, 2024
3e37631
Update docs/content/concepts/why-radius/application-graph/index.md
Reshrahim Feb 6, 2024
851b542
Revamp contribution guides
Reshrahim Feb 9, 2024
762bc5b
Remove untracked changes
Reshrahim Feb 9, 2024
9455294
Remove untracked changes
Reshrahim Feb 9, 2024
9b4765a
Remove untracked changes
Reshrahim Feb 9, 2024
3ad4d13
Merge branch 'v0.30' of https://github.com/Reshrahim/docs into v0.30
Reshrahim Feb 9, 2024
0a28e1b
Make community tope level
Reshrahim Feb 12, 2024
3fc5d0f
Merge branch 'v0.30' into v0.30
Reshrahim Feb 14, 2024
d002b0c
Delete package-lock.json
Reshrahim Feb 14, 2024
0968592
address feedback
Reshrahim Feb 14, 2024
7a3784e
Update docs/content/contributing/overview/index.md
Reshrahim Feb 14, 2024
a9bd635
Merge branch 'v0.30' of https://github.com/Reshrahim/docs into v0.30
Reshrahim Feb 14, 2024
3a21b21
Remove changes to package-lock.json
Reshrahim Feb 14, 2024
5a4368a
Restore package-lock.json
Reshrahim Feb 14, 2024
d92aed2
Merge branch 'v0.30' of https://github.com/Reshrahim/docs into v0.30
Reshrahim Feb 14, 2024
9257f7e
Resore package-lock.json
Reshrahim Feb 15, 2024
a7da466
Merge branch 'v0.30' into v0.30
Reshrahim Feb 15, 2024
2ffa957
Add aliase
Reshrahim Feb 15, 2024
ddbc98d
Address feedback
Reshrahim Feb 20, 2024
1540630
Merge branch 'v0.30' into v0.30
Reshrahim Feb 20, 2024
4d984cd
Address feedback
Reshrahim Feb 20, 2024
5c17e81
Merge branch 'v0.30' of https://github.com/Reshrahim/docs into v0.30
Reshrahim Feb 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/content/community/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ type: docs
title: "Radius Community"
linkTitle: "Community"
description: "Information about the Radius community"
weight: 90
---
weight: 120
---
27 changes: 0 additions & 27 deletions docs/content/community/contributing/github.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/content/community/contributing/overview/index.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/content/community/maintainers/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: docs
title: "Radius Community"
linkTitle: "Overview"
description: "Information about the Radius community"
weight: 100
weight: 200
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved
---

Welcome to the Radius community!
Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ type: docs
title: "Contributing to Radius"
linkTitle: "Contributing"
description: "Guides and requirements for contributing to Radius"
weight: 200
weight: 110
---
7 changes: 7 additions & 0 deletions docs/content/contributing/docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Radius Docs"
linkTitle: "Docs"
description: "Learn how to contribute and maintain the Radius documentation"
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved
weight: 300
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ 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"
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we not using the slug param anymore?

weight: 100
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved
---

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.
Expand Down
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
45 changes: 45 additions & 0 deletions docs/content/contributing/overview/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
type: docs
title: "Overview: Contributing to Radius"
linkTitle: "Overview"
description: "Guides and requirements for contributing to Radius"
weight: 100
---

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.
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved

<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 |
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved
|------------|-------------|---------------------|
| **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) |

### Troubleshooting common issues
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

This section seems like it would be better off in the common issues page.

Copy link
Contributor

Choose a reason for hiding this comment

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

Now that it's been moved into common issues we can remove it from here


#### 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
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved
File renamed without changes.
10 changes: 10 additions & 0 deletions docs/content/reference/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 0 additions & 2 deletions docs/content/tutorials/eshop/_index.md
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*
Loading