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

Deleting page content from _index.md files and renaming others to index.md #946

Merged
merged 7 commits into from
Dec 2, 2023
4 changes: 1 addition & 3 deletions docs/content/reference/api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,4 @@ title: "Radius API reference"
linkTitle: "Radius API"
description: "Detailed reference documentation on the Radius API"
weight: 400
---

## API resource policies
---
4 changes: 1 addition & 3 deletions docs/content/reference/api/applications.dapr/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@ type: docs
title: "Applications.Dapr API reference"
linkTitle: "Applications.Dapr"
description: "Detailed reference documentation on the Applications.Dapr API"
---

{{< redoc "swagger/specification/applications/resource-manager/Applications.Dapr/preview/2023-10-01-preview/openapi.json" >}}
---
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ linkTitle: "Applications.Datastores"
description: "Detailed reference documentation on the Applications.Datastores API"
---

{{< redoc "swagger/specification/applications/resource-manager/Applications.Datastores/preview/2023-10-01-preview/openapi.json" >}}
2 changes: 0 additions & 2 deletions docs/content/reference/api/applications.messaging/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@ title: "Applications.Messaging API reference"
linkTitle: "Applications.Messaging"
description: "Detailed reference documentation on the Applications.Messaging API"
---

{{< redoc "swagger/specification/applications/resource-manager/Applications.Messaging/preview/2023-10-01-preview/openapi.json" >}}
4 changes: 1 addition & 3 deletions docs/content/reference/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,4 @@ title: "Radius CLI reference"
linkTitle: "rad CLI"
description: "Detailed reference documentation on the Radius CLI"
weight: 100
---

## Available commands
---
56 changes: 0 additions & 56 deletions docs/content/reference/resource-schema/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,59 +5,3 @@ linkTitle: "Resource schemas"
description: "Schema docs for the resources that can comprise a Radius Application"
weight: 300
---

## Common values
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved

The following properties and values are available across all Radius resources:

| Key | Required | Description | Example |
|------|:--------:|-------------|---------|
| name | y | The name of your resource. | `mycontainer`
| location | y | The location of your resource. See [below](#location) for more information. The rad CLI defaults the value to 'global' for Radius resources. Direct API calls require `location` to be set to `'global'`. | `global`
| environment | y | The environment used by your resources for deployment. | `environment` |

### Name

The name of the resource defines how to address the resource within the context of the application.

#### Naming constraints

Radius resource names follow the DNS-1035 naming convention. This, plus other control-plane requirements, result in resource names that must:

- Contain at most 63 user-entered characters
- Contain only alphanumeric characters or '-'
- Start with an alphabetic character
- End with an alphanumeric character

#### Rendered names

The combination of the resource name and application name results in the rendered resource name in a self-hosted Kubernetes environment. The resource group name and resource name also result in the full Universal Control Plane (UCP) identifier of the resource.

For example, take the following values:

- **Resource name:** `mycontainer`
- **Application name:** `myapp`
- **Resource group name:** `myrg`

The resulting names are:

- **Rendered Kubernetes pod name:** `myapp-mycontainer`
- **Universal Control Plane (UCP) ID:** `/planes/local/resourcegroups/myrg/providers/Applications.Core/containers/mycontainer`

### Location

The location property defines where to deploy a resource within the targeted platform.

For self-hosted environments, the location property is defaulted to `global` by the rad CLI to indicate the resource is scoped to the entire underlying cluster. Direct API calls require `location` to be set to `'global'`. This is a point-in-time implementation that will be revisited in a future revision of self-hosted Kubernetes environments.

### Environment parameter

The `environment` string parameter is automatically injected into your Bicep template using the environment ID value specified in your default [workspace]({{< ref workspaces >}}). This value can also be overridden with the rad CLI: `rad deploy --params environment="/planes/radius/..."`.

To access the auto-injected value, specify an `environment` string parameter in your Bicep file:

```bicep
param environment string
```

## Resource categories
2 changes: 1 addition & 1 deletion docs/content/reference/resource-schema/cache/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ type: docs
title: "Cache links"
linkTitle: "Cache"
description: "Learn what cache links are available in your application"
weight: 300
weight: 400
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,5 @@ type: docs
title: "Core resource schemas"
linkTitle: "Core"
description: "Reference the schemas of the core Radius resources"
weight: 100
---

## Core resources
weight: 200
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,4 @@ type: docs
title: "Radius Volumes"
linkTitle: "Volumes"
description: "Learn about Radius volumes"
---

A Radius volume allows you to model an outside resource as a volume that can be mounted to one or more containers. It has a lifecycle that is separate from the container lifecycle, ensuring that data is persisted across container restarts and mounts.

Refer to the [container docs]({{< ref container-schema >}}) to learn how to mount a volume to a container.

## Supported resources
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ type: docs
title: "Database links"
linkTitle: "Databases"
description: "Learn what database resources are available in your application"
weight: 200
weight: 300
---
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ type: docs
title: "Messaging"
linkTitle: "Messaging"
description: "Learn what messaging resources are available in your application"
weight: 400
weight: 500
---
62 changes: 62 additions & 0 deletions docs/content/reference/resource-schema/overview/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
type: docs
title: "Overview: Resource schemas"
linkTitle: "Overview"
description: "Schema docs for the resources that can comprise a Radius Application"
categories: "Overview"
weight: 100
---

## Common values

The following properties and values are available across all Radius resources:

| Key | Required | Description | Example |
|------|:--------:|-------------|---------|
| name | y | The name of your resource. | `mycontainer`
| location | y | The location of your resource. See [below](#location) for more information. The rad CLI defaults the value to 'global' for Radius resources. Direct API calls require `location` to be set to `'global'`. | `global`
| environment | y | The environment used by your resources for deployment. | `environment` |

### Name

The name of the resource defines how to address the resource within the context of the application.

#### Naming constraints

Radius resource names follow the DNS-1035 naming convention. This, plus other control-plane requirements, result in resource names that must:

- Contain at most 63 user-entered characters
- Contain only alphanumeric characters or '-'
- Start with an alphabetic character
- End with an alphanumeric character

#### Rendered names

The combination of the resource name and application name results in the rendered resource name in a self-hosted Kubernetes environment. The resource group name and resource name also result in the full Universal Control Plane (UCP) identifier of the resource.

For example, take the following values:

- **Resource name:** `mycontainer`
- **Application name:** `myapp`
- **Resource group name:** `myrg`

The resulting names are:

- **Rendered Kubernetes pod name:** `myapp-mycontainer`
- **Universal Control Plane (UCP) ID:** `/planes/local/resourcegroups/myrg/providers/Applications.Core/containers/mycontainer`

### Location

The location property defines where to deploy a resource within the targeted platform.

For self-hosted environments, the location property is defaulted to `global` by the rad CLI to indicate the resource is scoped to the entire underlying cluster. Direct API calls require `location` to be set to `'global'`. This is a point-in-time implementation that will be revisited in a future revision of self-hosted Kubernetes environments.

### Environment parameter

The `environment` string parameter is automatically injected into your Bicep template using the environment ID value specified in your default [workspace]({{< ref workspaces >}}). This value can also be overridden with the rad CLI: `rad deploy --params environment="/planes/radius/..."`.

To access the auto-injected value, specify an `environment` string parameter in your Bicep file:

```bicep
param environment string
```
Loading