From 47e30c0ea9b6a620160bd9deb35d291ed890a963 Mon Sep 17 00:00:00 2001 From: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Date: Wed, 21 Feb 2024 15:08:57 -0500 Subject: [PATCH] Revamp contribution guides (#1041) * Hide old application graph page Signed-off-by: Reshma Abdul Rahim * Update docs/content/concepts/why-radius/application-graph/index.md Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> * Revamp contribution guides Signed-off-by: Reshma Abdul Rahim * Remove untracked changes * Remove untracked changes * Remove untracked changes * fix workspace switch cli example (#1029) Signed-off-by: Emanuel Palm Signed-off-by: Reshma Abdul Rahim * Hide old application graph page Signed-off-by: Reshma Abdul Rahim * Update docs/content/concepts/why-radius/application-graph/index.md Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim * Revamp contribution guides Signed-off-by: Reshma Abdul Rahim * Remove untracked changes Signed-off-by: Reshma Abdul Rahim * Remove untracked changes Signed-off-by: Reshma Abdul Rahim * Remove untracked changes Signed-off-by: Reshma Abdul Rahim * Make community tope level Signed-off-by: Reshma Abdul Rahim * Delete package-lock.json Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> * address feedback Signed-off-by: Reshma Abdul Rahim * Update docs/content/contributing/overview/index.md Co-authored-by: Aaron Crawfis Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> * Remove changes to package-lock.json Signed-off-by: Reshma Abdul Rahim * Restore package-lock.json Signed-off-by: Reshma Abdul Rahim * Resore package-lock.json Signed-off-by: Reshma Abdul Rahim * Add aliase Signed-off-by: Reshma Abdul Rahim * Address feedback Signed-off-by: Reshma Abdul Rahim * Address feedback Signed-off-by: Reshma Abdul Rahim --------- Signed-off-by: Reshma Abdul Rahim Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Emanuel Palm Co-authored-by: Emanuel Palm Co-authored-by: Aaron Crawfis --- docs/content/community/_index.md | 4 +- docs/content/community/contributing/github.md | 27 ------------- .../community/contributing/overview/index.md | 19 --------- docs/content/community/maintainers/_index.md | 7 ---- .../index.md} | 2 +- .../{overview.md => overview/index.md} | 6 +-- .../{community => }/contributing/_index.md | 2 +- docs/content/contributing/docs/_index.md | 7 ++++ .../docs}/architecture.png | Bin .../docs}/contributing-docs/diataxis.png | Bin .../docs}/contributing-docs/index.md | 4 +- .../docs/maintainers-docs/index.md} | 1 + docs/content/contributing/overview/index.md | 36 ++++++++++++++++++ .../presentations/index.md | 1 + docs/content/reference/limitations.md | 10 +++++ docs/content/tutorials/eshop/_index.md | 2 - 16 files changed, 63 insertions(+), 65 deletions(-) delete mode 100644 docs/content/community/contributing/github.md delete mode 100644 docs/content/community/contributing/overview/index.md delete mode 100644 docs/content/community/maintainers/_index.md rename docs/content/community/{media-coverage.md => media-coverage/index.md} (99%) rename docs/content/community/{overview.md => overview/index.md} (86%) rename docs/content/{community => }/contributing/_index.md (92%) create mode 100644 docs/content/contributing/docs/_index.md rename docs/content/{community/contributing => contributing/docs}/architecture.png (100%) rename docs/content/{community/contributing => contributing/docs}/contributing-docs/diataxis.png (100%) rename docs/content/{community/contributing => contributing/docs}/contributing-docs/index.md (99%) rename docs/content/{community/maintainers/docs-maintainers.md => contributing/docs/maintainers-docs/index.md} (97%) create mode 100644 docs/content/contributing/overview/index.md rename docs/content/{community => contributing}/presentations/index.md (97%) diff --git a/docs/content/community/_index.md b/docs/content/community/_index.md index 96daf0a19..99ddef454 100644 --- 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 +--- \ No newline at end of file diff --git a/docs/content/community/contributing/github.md b/docs/content/community/contributing/github.md deleted file mode 100644 index 1273f5dfb..000000000 --- a/docs/content/community/contributing/github.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -type: docs -title: "Radius GitHub organization" -linkTitle: "GitHub" -description: "Learn where the Radius source code and issues are located" -weight: 200 ---- - -Radius is a community-driven project that lives on GitHub within the [Radius organization](https://github.com/radius-project). - -## Source code - -The source code for Radius is available on GitHub within the [radius repo](https://github.com/radius-project/radius). - -Documentation is housed at https://github.com/radius-project/docs. - -Samples are located at https://github.com/radius-project/samples. - -## Troubleshooting common issues - -### 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 \ No newline at end of file diff --git a/docs/content/community/contributing/overview/index.md b/docs/content/community/contributing/overview/index.md deleted file mode 100644 index eceae304a..000000000 --- a/docs/content/community/contributing/overview/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -type: docs -title: "Overview: Contributing to Radius" -linkTitle: "Overview" -description: "Guides and requirements for contributing to Radius" -weight: 100 ---- - -We welcome contributions to the Radius! Check out the following table to learn where and how you can contribute: - -| Component | Description | Contribution guides | -|-----------|-------------|---------------------| -| **`rad` CLI** | Deploys and manages Radius resources | [radius-project/radius](https://github.com/radius-project/radius/blob/main/docs/contributing/contributing-code/contributing-code-cli/running-rad-cli.md) | -| **Bicep** | Language and tools which includes the application model as a set of types which will eventually be merged with https://github.com/azure/bicep | [radius-project/bicep](https://github.com/radius-project/bicep/blob/radius-compiler/CONTRIBUTING.md) | -| **ARM Deployment Engine** | Processes the output of the Bicep compiler and deploys resources | [radius-project/deployment-engine](https://github.com/radius-project/deployment-engine/blob/main/CONTRIBUTING.md) | -| **Radius Control Plane** | Implements operations on the application model as a sequence of resource management operations | [radius-project/radius](https://github.com/radius-project/radius/tree/main/docs/contributing/contributing-code) | -| **Dashboard** | The frontend experience for Radius | [radius-project/dashboard](https://github.com/radius-project/dashboard/blob/main/CONTRIBUTING.md) | -| **Recipes** | Commonly used [Recipe](https://docs.radapp.dev/recipes) templates for Radius Environments | [radius-project/recipes](https://github.com/radius-project/recipes/blob/main/CONTRIBUTING.md) | -| **Docs** | Documentation for Radius | [Contributing to docs]({{< ref contributing-docs >}}) | diff --git a/docs/content/community/maintainers/_index.md b/docs/content/community/maintainers/_index.md deleted file mode 100644 index 00fec77bf..000000000 --- a/docs/content/community/maintainers/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Maintainer guides for Radius" -linkTitle: "Maintainers" -description: "Guides and requirements for Radius maintainers" -weight: 300 ---- diff --git a/docs/content/community/media-coverage.md b/docs/content/community/media-coverage/index.md similarity index 99% rename from docs/content/community/media-coverage.md rename to docs/content/community/media-coverage/index.md index 5e2b3fab8..93291464d 100644 --- a/docs/content/community/media-coverage.md +++ b/docs/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 b/docs/content/community/overview/index.md similarity index 86% rename from docs/content/community/overview.md rename to docs/content/community/overview/index.md index 160d9132c..fef8e1bfa 100644 --- a/docs/content/community/overview.md +++ b/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/docs/content/community/contributing/_index.md b/docs/content/contributing/_index.md similarity index 92% rename from docs/content/community/contributing/_index.md rename to docs/content/contributing/_index.md index 76447d68c..9de6f74b3 100644 --- a/docs/content/community/contributing/_index.md +++ b/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 --- \ No newline at end of file diff --git a/docs/content/contributing/docs/_index.md b/docs/content/contributing/docs/_index.md new file mode 100644 index 000000000..578d023bf --- /dev/null +++ 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 +--- \ No newline at end of file diff --git a/docs/content/community/contributing/architecture.png b/docs/content/contributing/docs/architecture.png similarity index 100% rename from docs/content/community/contributing/architecture.png rename to docs/content/contributing/docs/architecture.png diff --git a/docs/content/community/contributing/contributing-docs/diataxis.png b/docs/content/contributing/docs/contributing-docs/diataxis.png similarity index 100% rename from docs/content/community/contributing/contributing-docs/diataxis.png rename to docs/content/contributing/docs/contributing-docs/diataxis.png diff --git a/docs/content/community/contributing/contributing-docs/index.md b/docs/content/contributing/docs/contributing-docs/index.md similarity index 99% rename from docs/content/community/contributing/contributing-docs/index.md rename to docs/content/contributing/docs/contributing-docs/index.md index c0bd16afb..ff0394b0e 100644 --- a/docs/content/community/contributing/contributing-docs/index.md +++ b/docs/content/contributing/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/docs/content/community/maintainers/docs-maintainers.md b/docs/content/contributing/docs/maintainers-docs/index.md similarity index 97% rename from docs/content/community/maintainers/docs-maintainers.md rename to docs/content/contributing/docs/maintainers-docs/index.md index bb3ff8c5b..6067d197b 100644 --- a/docs/content/community/maintainers/docs-maintainers.md +++ b/docs/content/contributing/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 new file mode 100644 index 000000000..4e0a0c339 --- /dev/null +++ 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. + +good-first-issues + +### 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/docs/content/community/presentations/index.md b/docs/content/contributing/presentations/index.md similarity index 97% rename from docs/content/community/presentations/index.md rename to docs/content/contributing/presentations/index.md index 03a2d3a1e..47e42f98a 100644 --- a/docs/content/community/presentations/index.md +++ b/docs/content/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 index 6751b40e9..9f470d7bc 100644 --- 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 index bdb3a4457..3fba2cff3 100644 --- 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*