Skip to content

Commit

Permalink
Merge branch 'edge' into jasonviviano/kubernetes-incremental-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonviviano authored Oct 24, 2023
2 parents 2e1ac34 + fd026c6 commit 7883158
Show file tree
Hide file tree
Showing 109 changed files with 819 additions and 316 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/typo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: ''
---

**URL of the docs page**
<!--The URL(s) on docs.radapp.dev where the typo occurs-->
<!--The URL(s) on docs.radapp.io where the typo occurs-->

**How is it currently worded?**
<!--Please copy and paste the sentence where the typo occurs-->
Expand Down
27 changes: 27 additions & 0 deletions .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ ClusterIssuer
CLI
CLIs
CMD
CNCF
CQRS
CRDs
CRUDL
Expand All @@ -41,6 +42,7 @@ DocumentDB
dcd
EKS
eksClusterName
ElastiCache
entrypoint
EOF
Extensibility
Expand Down Expand Up @@ -90,6 +92,7 @@ PowerShell
Pre
PubSub
ProjectRadius
radify
RBAC
RabbitMQ
ResourceDeploymentClient
Expand Down Expand Up @@ -958,6 +961,7 @@ PodSpec
composable
CRD
nd
OSI
scaffolded
bb
df
Expand All @@ -966,6 +970,7 @@ mongodatabases
secureString
btdgzez
bzmp
Webhook
Appi
ness
DevOps
Expand All @@ -979,3 +984,25 @@ SRE
SREs
OSI
ghcr
png
src
todoapp
todolist
mockup
diataxis
appdiagram
tmp
jpg
buildingblocks
svg
ClusterIP
NodePort
replicaset
radified
cd
ddgq
dfc
fh
qd
vf
zht
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Thank you for helping make the Radius documentation better!

**Please follow this checklist before submitting:**

- [ ] [Read the contribution guide](https://docs.radapp.dev/contributing/docs/)
- [ ] [Read the contribution guide](https://docs.radapp.io/community/contributing/docs/)
- [ ] Commands include options for Linux, MacOS, and Windows within codetabs
- [ ] New file and folder names are globally unique
- [ ] Page references use shortcodes instead of markdown or URL links
Expand Down
2 changes: 1 addition & 1 deletion .github/scripts/algolia.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from bs4 import BeautifulSoup
from algoliasearch.search_client import SearchClient

url = "docs.radapp.dev"
url = "docs.radapp.io"
if len(sys.argv) > 1:
starting_directory = os.path.join(os.getcwd(), str(sys.argv[1]))
else:
Expand Down
4 changes: 2 additions & 2 deletions .github/scripts/release-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ pushd $REPOSITORY

git checkout -B "${CHANNEL_VERSION}"

# In docs/config.toml, change baseURL to https://docs.radapp.dev/ instead of https://edge.docs.radapp.dev/
awk '{gsub(/baseURL = \"https:\/\/edge\.docs\.radapp.dev\/\"/,"baseURL = \"https:\/\/docs.radapp.dev\/\""); print}' docs/config.toml > docs/config.toml.tmp
# In docs/config.toml, change baseURL to https://docs.radapp.io/ instead of https://edge.docs.radapp.io/
awk '{gsub(/baseURL = \"https:\/\/edge\.docs\.radapp.io\/\"/,"baseURL = \"https:\/\/docs.radapp.io\/\""); print}' docs/config.toml > docs/config.toml.tmp
mv docs/config.toml.tmp docs/config.toml

# In docs/config.toml, change version to VERSION instead of edge
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/spellcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
echo "## :x: Spellcheck Failed" >> $GITHUB_STEP_SUMMARY
echo "There are spelling errors in your PR. Visit [the workflow output](${{ env.ACTION_LINK }}) to see what words are failing." >> $GITHUB_STEP_SUMMARY
echo "### Adding new words" >> $GITHUB_STEP_SUMMARY
echo "If you are adding a new custom word refer to the [docs guide](https://docs.radapp.dev/contributing/docs/#spelling)" >> $GITHUB_STEP_SUMMARY
echo "If you are adding a new custom word refer to the [docs guide](https://docs.radapp.io/contributing/docs/#spelling)" >> $GITHUB_STEP_SUMMARY
- name: Post GitHub workflow output on success
run: |
echo "## :white_check_mark: Spellcheck Passed" >> $GITHUB_STEP_SUMMARY
Expand All @@ -50,7 +50,7 @@ jobs:
## :x: Spellcheck Failed
There are spelling errors in your PR. Visit [the workflow output](${{ env.ACTION_LINK }}) to see what words are failing.
### Adding new words
If you are adding a new custom word refer to the [docs guide](https://docs.radapp.dev/contributing/docs/#spelling)
If you are adding a new custom word refer to the [docs guide](https://docs.radapp.io/contributing/docs/#spelling)
- name: Clear GitHub comment on success
uses: marocchino/sticky-pull-request-comment@v2
continue-on-error: true
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: ${{ github.ref_name == 'edge' && 'edge' || 'latest' }}
url: ${{ github.ref_name == 'edge' && 'https://edge.docs.radapp.dev' || 'https://docs.radapp.dev' }}
url: ${{ github.ref_name == 'edge' && 'https://edge.docs.radapp.io' || 'https://docs.radapp.io' }}
steps:
- name: Checkout docs repo
uses: actions/checkout@v3
Expand Down Expand Up @@ -111,7 +111,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: ${{ github.ref_name == 'edge' && 'edge' || 'latest' }}
url: ${{ github.ref_name == 'edge' && 'https://edge.docs.radapp.dev' || 'https://docs.radapp.dev' }}
url: ${{ github.ref_name == 'edge' && 'https://edge.docs.radapp.io' || 'https://docs.radapp.io' }}
steps:
- name: Download Hugo artifacts
uses: actions/download-artifact@v3
Expand Down Expand Up @@ -152,7 +152,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: ${{ github.ref_name == 'edge' && 'edge' || 'latest' }}
url: ${{ github.ref_name == 'edge' && 'https://edge.docs.radapp.dev' || 'https://docs.radapp.dev' }}
url: ${{ github.ref_name == 'edge' && 'https://edge.docs.radapp.io' || 'https://docs.radapp.io' }}
steps:
- name: Close Pull Request
id: closepullrequest
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Contributing to Radius documentation

Thank you for your interesting in contributing to the Radius documentation! For more information please refer to [https://docs.radapp.dev/community/contributing/docs/](https://docs.radapp.dev/community/contributing/docs/)
Thank you for your interesting in contributing to the Radius documentation! For more information please refer to [https://docs.radapp.io/community/contributing/docs/](https://docs.radapp.io/community/contributing/docs/)
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 📕 Radius documentation

This repo contains the documentation source for https://radapp.dev
This repo contains the documentation source for https://radapp.io

## 📦 Framework

Expand All @@ -16,7 +16,7 @@ The [rad CLI](https://github.com/radius-project/radius/tree/main/cmd/rad) refere

## 👨‍💻 Contributing

Visit the [docs contribution guide](https://radapp.dev/contributing/contributing-docs/) to learn how to contribute to the docs.
Visit the [docs contribution guide](https://radapp.io/contributing/contributing-docs/) to learn how to contribute to the docs.

### Local server

Expand All @@ -28,11 +28,11 @@ The Radius docs are hosted on Azure App Service.

### Latest docs

The latest release docs are available at https://radapp.dev
The latest release docs are available at https://radapp.io

### Edge docs

Edge docs are available at https://edge.radapp.dev
Edge docs are available at https://edge.radapp.io

### Staging docs

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Radius documentation

This directory contains the files to generate the https://docs.radapp.dev site. Please go there to consume Radius docs. This document will describe how to build Radius docs locally.
This directory contains the files to generate the https://docs.radapp.io site. Please go there to consume Radius docs. This document will describe how to build Radius docs locally.

## Codespace

Expand Down
18 changes: 12 additions & 6 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
baseURL = "https://edge.docs.radapp.dev/"
baseURL = "https://edge.docs.radapp.io/"
languageCode = "en-us"
title = "Radius Docs"
theme = "docsy"
Expand Down Expand Up @@ -47,8 +47,13 @@ tag = "tags"
[[menu.main]]
name = "Home"
weight = 10
url = "https://radapp.dev"
url = "https://radapp.io"
pre = "<i class='fas fa-home'></i>"
[[menu.main]]
name = "Blog"
weight = 20
url = "https://blog.radapp.io"
pre = "<i class='fas fa-blog'></i>"
[[menu.main]]
name = "GitHub"
weight = 40
Expand All @@ -57,14 +62,15 @@ tag = "tags"
[[menu.main]]
name = "Discord"
weight = 90
url = "https://discord.gg/SRG3ePMKNy"
url = "https://aka.ms/Radius/Discord"
pre = "<i class='fab fa-discord'></i>"

[params]
copyright = "Radius"

version = "edge"
tag_version = "latest"
chart_version = "0.19.0"
chart_version = "0.26.0"

# Algolia Search
algolia_docsearch = true
Expand All @@ -79,11 +85,11 @@ github_project_repo = "https://github.com/radius-project/radius"
version_menu = "Releases"
[[params.versions]]
version = "edge (preview)"
url = "https://edge.docs.radapp.dev"
url = "https://edge.docs.radapp.io"

[[params.versions]]
version = "latest"
url = "https://docs.radapp.dev"
url = "https://docs.radapp.io"

# Markdown Engine - Allow inline html
[markup]
Expand Down
6 changes: 3 additions & 3 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
type: docs
title: "Radius Cloud-Native Application Platform"
title: "Radius Documentation"
linkTitle: "Home"
description: "Radius enables developers and the platform engineers that support them to build cloud-native applications"
weight: 1
Expand All @@ -10,10 +10,10 @@ no_list: true
Welcome to the Radius documentation! Here you'll find everything you need to know about Radius, from getting started to advanced topics.

{{% alert color="primary" %}}
<img src="radius-logo.svg" alt="Radius logo" width="400px" /> <br /><br />
{{< image src="radius-logo.svg" alt="Radius logo" width="400px" >}} <br /><br />
Radius is a cloud native application platform. It enables developers and IT operators to collaborate on delivering and managing cloud-native applications. With Radius, teams can easily understand their applications and how applications are running environments including dev, cloud, edge, and on-prem. Plus, teams can ensure their application infrastructure meets cost, operations, and security requirements. Open-source and multi-cloud, Radius is the cloud-native application platform for delivering and managing applications anywhere.

[**Learn more**](https://radapp.dev/)
[**Learn more**](https://radapp.io/)
{{% /alert %}}

{{< button text="Get started with Radius 🚀" page="getting-started" color="success" size="btn-lg" >}}
Expand Down
10 changes: 6 additions & 4 deletions docs/content/community/contributing/contributing-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Radius docs are built on [Hugo](https://gohugo.io) with the [Docsy](https://

Radius uses the [Diátaxis framework](https://diataxis.fr/) for its documentation:

<img src="diataxis.png" alt="Diagram showing the diataxis framework" width=800px >
{{< image src="diataxis.png" alt="Diagram showing the diataxis framework" width=800px >}}

Follow the guidance on this page to learn how to get started, how to contribute, and how to use the Diátaxis framework to create new docs.

Expand Down Expand Up @@ -204,8 +204,10 @@ Front-matter should be completed with all fields including type, title, linkTitl
- `categories` should be one of the following:
- Concept
- Overview
- Reference application
- Tutorial
- How-To
- Reference
- Schema
- `tags` should be a comma-separated list of metadata tags.

As per the [styling conventions](#styling-conventions), titles should only capitalize the first word and proper nouns, with the exception of "How-To:"
Expand Down Expand Up @@ -354,7 +356,7 @@ Begin by placing images under `/daprdocs/static/images` with the naming conventi
Then link to the image using:

```md
<img src="/images/[image-filename]" width=1000 alt="Description of image">
{{</* image src="/images/[image-filename]" width=1000 alt="Description of image" */>}}
```

>Don't forget to set the alt attribute to keep the docs readable for our visually impaired users.
Expand All @@ -364,7 +366,7 @@ Then link to the image using:
This HTML will display the `radius-overview.png` image on the `overview.md` page:

```md
<img src="/images/radius-overview.png" width=1000 alt="Overview diagram of Dapr and its building blocks">
{{</* image src="radius-overview.png" width=1000 alt="Overview diagram of Dapr and its building blocks" */>}}
```

### Alerts
Expand Down
6 changes: 3 additions & 3 deletions docs/content/concepts/application-graph/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ toc_hide: true

Radius offers an [application resource]({{< ref "guides/author-apps/application" >}}) which teams can use to define and deploy their entire application, including all of the compute, relationships, and infrastructure that make up the application. Since the graph of relationships between deployed resources is much more descriptive than a basic list of resources, the Radius Application graph can automate complex deployment tasks and enable rich visualization experiences.

<img src="application.png" alt="A diagram showing an application and all it's resources" width=400px >
{{< image src="application.png" alt="A diagram showing an application and all it's resources" width=400px >}}

## Graphs are better than lists

Within an application deployed with Radius, developers can express both the resources (_containers, databases, message queues, etc._), as well as all the relationships between them. This forms the Radius Application graph. This graph is powerful because it allows Radius to understand the relationships between resources, simplifying the [deployment]({{< ref "/guides/deploy-apps" >}}) and [configuration]({{< ref "application" >}}) of your application. Plus, it allows you to visualize your application in a way that is more intuitive than a list of resources.

<img src="list-to-graph.png" alt="A diagram showing the move from a set of infrastructure lists to a graph of resources" width=600px >
{{< image src="list-to-graph.png" alt="A diagram showing the move from a set of infrastructure lists to a graph of resources" width=600px >}}

## Self-documenting applications

The Radius Application graph also allows your application to be self-documenting, where developers and operators can query and reason about the same application definition. Instead of multiple views of logs, infrastructure, and code, Radius provides a single source of truth for your application.

<img src="dashboard.png" alt="A mockup of a dashboard UI showing an application, its resources, and its connections" width=700px >
{{< image src="dashboard.png" alt="A mockup of a dashboard UI showing an application, its resources, and its connections" width=700px >}}

> **Note:** A Radius dashboard is still on the roadmap, but in the meantime you can use the [Radius API]({{< ref api-concept >}}) to build your own visual experiences today.
Expand Down
6 changes: 3 additions & 3 deletions docs/content/concepts/architecture-concept/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ When listing applications using the `rad` CLI:
3. UCP proxies the HTTP request to the `Applications.Core` resource provider.
4. The `Applications.Core` resource provider handles the request and responds with the list of applications.

<img src="flow-list-apps.png" alt="Diagram of the API flow described above" width="1000px" >
{{< image src="flow-list-apps.png" alt="Diagram of the API flow described above" width="1000px" >}}

{{% /codetab %}}

Expand All @@ -148,7 +148,7 @@ When using Bicep to author and deploy Radius Applications:
a. The `Bicep.Deployments` resource provider makes a request to UCP to Create/Update the resource.
b. UCP routes the request to the appropriate resource provider to be handled.

<img src="flow-deploy.png" alt="Diagram of the API flow described above" width="1000px" >
{{< image src="flow-deploy.png" alt="Diagram of the API flow described above" width="1000px" >}}

{{% /codetab %}}

Expand All @@ -161,7 +161,7 @@ When using the `tf` CLI to deploy a Radius Application using Terraform:
c. In the case of a Radius resource the Terraform provider makes a request the Radius API to Create/Update a resource.
d. UCP routes the request to the appropriate resource provider to be handled.

<img src="flow-terraform.png" alt="Diagram of the API flow described above" width="1000px" >
{{< image src="flow-terraform.png" alt="Diagram of the API flow described above" width="1000px" >}}

{{% /codetab %}}

Expand Down
2 changes: 1 addition & 1 deletion docs/content/concepts/environments-concept/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Radius Environments are a prepared landing zone for applications. They contain a

Environments provide a grouping structure for applications and the resources they share. For example, an org might choose to setup separate Radius Environments for staging and production. When appropriate, multiple applications can be deployed into the same environment.

<img src="env-with-apps-example.png" alt="Diagram of multiple Radius Environments deployed to Azure. One environment contains 1 app, the other environment contains multiple apps." width="350px" />
{{< image src="env-with-apps-example.png" alt="Diagram of multiple Radius Environments deployed to Azure. One environment contains 1 app, the other environment contains multiple apps." width="350px" >}}

## Concerns that environments manage

Expand Down
Loading

0 comments on commit 7883158

Please sign in to comment.