Skip to content

Commit

Permalink
Update structure
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronCrawfis committed Jul 10, 2023
1 parent fc3f658 commit be5f41f
Show file tree
Hide file tree
Showing 14 changed files with 73 additions and 48 deletions.
7 changes: 7 additions & 0 deletions docs/content/community/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Radius Community"
linkTitle: "Community"
description: "Overview of the Radius community"
weight: 85
---
7 changes: 7 additions & 0 deletions docs/content/community/contributing/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Contributing to Radius"
linkTitle: "Contributing"
description: "Guides and requirements for contributing to Radius"
weight: 200
---
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: docs
title: "Contributing to Radius documentation"
linkTitle: "Docs"
description: "How to contribute to the Radius documentation"
weight: 200
weight: 300
slug: "docs"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
---
type: docs
title: "Maintaining Radius docs"
linkTitle: "Docs"
weight: 200
description: "Learn about the Radius docs maintenance process"
title: "Maintainer guides for Radius"
linkTitle: "Maintainers"
description: "Guides and requirements for Radius maintainers"
weight: 999
---

## Docs repo

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 [`project-radius/docs`](https://github.com/project-radius/docs) repo.

To learn how to contribute to Radius docs, review the [Contributor guide]({{< ref contributing-docs >}}).

## Branch guidance
### Branch guidance

The Radius docs handles branching differently than most code repositories. Instead of a `main` branch, every branch is labeled to match the major and minor version of a runtime release, plus an `edge` branch for in-flight work. For example, the `v1.0` branch contains the docs for the `v1.0` release. The `edge` branch contains the latest in-flight work.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
type: docs
title: "Contributing to Radius"
linkTitle: "Contributing"
description: "Guides and requirements for contributing to Radius"
weight: 80
no_list: true
title: "Contributing to Radius overview"
linkTitle: "Overview"
description: "Learn how to contribute to Radius"
weight: 100
---

We welcome contributions to the Radius! Check out the following table to learn where and how you can contribute:
Expand All @@ -17,3 +16,11 @@ We welcome contributions to the Radius! Check out the following table to learn
| **Radius Control Plane** | Implements operations on the application model as a sequence of resource management operations | [project-radius/radius](https://github.com/project-radius/radius/tree/main/docs/contributing/contributing-code) |
| **Templates** | Deployable starter templates for getting up and running with Radius | [project-radius/templates](https://github.com/project-radius/templates) |
| **Docs** | Documentation for Radius | [Contributing to docs]({{< ref contributing-docs >}}) |

## GitHub organization

Radius is a community-driven project that lives on GitHub within the [Radius organization](https://github.com/project-radius).

### Access

Visit https://aka.ms/ProjectRadius/GitHubAccess to request access to the Radius GitHub organization.
10 changes: 5 additions & 5 deletions docs/content/community.md → docs/content/community/overview.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
type: docs
title: "Radius Community"
linkTitle: "Community"
title: "Radius Community Overview"
linkTitle: "Overview"
description: "Information about the Radius community"
weight: 85
weight: 100
---

Welcome to the Radius community. We are currently in a private release phase which is open to Microsoft FTEs and select partners. The team is working on a public preview release which will be announced on this page.
Expand Down Expand Up @@ -40,8 +40,8 @@ To present a specific topic on the next Radius community call start by filling o

## GitHub Issues & repositories

GitHub access is optional and not required to try out and run Radius. If you would like to directly file Issues and have access to the source code, please contact your Radius Core Team contact.
GitHub access is optional and not required to try out and run Radius. If you would like to directly file Issues and have access to the source code, refer to the [GitHub organization docs]({{< ref "community/contributing/overview" >}}).

## How can I get involved?

One of the easiest ways to contribute is to participate in discussions at community engagements or the Teams channel. We are always seeking feedback from. Suggestions around improving the product and docs are always welcome.
Visit the [Radius contribution docs]({{< ref contributing >}}) for more information on how to contribute to Radius.
21 changes: 0 additions & 21 deletions docs/content/contributing/github.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/content/contributing/maintainers/_index.md

This file was deleted.

7 changes: 7 additions & 0 deletions docs/content/support/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Radius support"
linkTitle: "Support"
description: "How to get help and ask questions about Radius"
weight: 999
---
25 changes: 25 additions & 0 deletions docs/content/support/contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
type: docs
title: "Getting help with Radius"
linkTitle: "Help"
description: "What to do if you need help with Radius and need support"
weight: 100
---

## Troubleshoot a problem

Visit the [troubleshooting docs]({{< ref "support/troubleshooting" >}}) for help with common issues.

{{< button text="Troubleshooting" page="support/troubleshooting" >}}

## Discord: Ask questions and chat with the community

For general questions, you can join the [Radius Discord server](https://discord.gg/SRG3ePMKNy) and ask in the `#general` or `#forum` channels. A member of the Radius team will respond as soon as possible.

{{< button text="Radius Discord" link="https://discord.gg/SRG3ePMKNy" newtab="true" >}}

## GitHub Issue: File a bug report or feature request

If you have a bug report or feature request, please [open an issue on GitHub](https://github.com/project-radius/radius/issues/new/choose). Visit the [Issue contribution docs](https://github.com/project-radius/radius/blob/main/docs/contributing/contributing-issues/README.md) to learn how to open an issue and what to include.

{{< button text="Open a new issue" link="https://github.com/project-radius/radius/issues/new/choose" newtab="true" >}}
2 changes: 1 addition & 1 deletion docs/content/faq.md → docs/content/support/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: docs
title: "Frequently asked questions"
linkTitle: "FAQ"
description: "Commonly asked questions about best practices"
weight: 999
weight: 300
---

## Applications
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: docs
title: "Troubleshoot issues and common problems"
linkTitle: "Troubleshooting"
description: "Common issues users may have with Radius and how to address them"
weight: 900
weight: 200
categories: "How-To"
tags: ["troubleshooting"]
---
Expand Down

0 comments on commit be5f41f

Please sign in to comment.