Skip to content

Commit

Permalink
Merge branch 'edge' into aacrawfi/shared-resource
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonviviano authored Nov 7, 2023
2 parents d160c8c + afe033c commit d4f7444
Show file tree
Hide file tree
Showing 229 changed files with 2,844 additions and 1,622 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
2 changes: 2 additions & 0 deletions .github/config/.pyspelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ matrix:
- .github/config/en-custom.txt
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- markdown.extensions.fenced_code
- pyspelling.filters.html:
comments: false
ignores:
Expand Down
65 changes: 64 additions & 1 deletion .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ ClusterIssuer
CLI
CLIs
CMD
CNCF
CQRS
CRDs
CRUDL
Expand All @@ -39,6 +40,7 @@ Docsy
DocumentDB
EKS
eksClusterName
ElastiCache
entrypoint
EOF
Extensibility
Expand Down Expand Up @@ -88,6 +90,7 @@ PowerShell
Pre
PubSub
ProjectRadius
radify
RBAC
RabbitMQ
ResourceDeploymentClient
Expand Down Expand Up @@ -946,4 +949,64 @@ XRay
PodSpec
ConfigMap
CRD
composable
composable
gatewaydemo
tlsdemo
ConfigMap
PodSpec
composable
CRD
nd
OSI
scaffolded
bb
df
rc
mongodatabases
secureString
btdgzez
bzmp
Webhook
Appi
ness
DevOps
DevSecOps
learnings
architected
customizable
Gitops
OSS
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
Elasticache
FinOps
SecOps
podspec
sngm
nmqpk
fluentbit
nmqpk
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
51 changes: 15 additions & 36 deletions .github/workflows/website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@ jobs:
name: Build Hugo Website
if: github.event.action != 'closed'
runs-on: ubuntu-latest
environment:
name: ${{ github.ref_name == 'edge' && 'edge' || 'latest' }}
env:
GOVER: '^1.17'
TUTORIAL_PATH: './docs/content/user-guides/tutorials/'
CODE_ZIP_PATH: './docs/static/tutorial/'
HUGO_VERSION: 0.117.0
HUGO_ENV: production
SWA_BASE: 'wonderful-plant-020417a1e'
steps:
- name: Checkout docs repo
uses: actions/checkout@v3
Expand All @@ -38,10 +39,6 @@ jobs:
ref: ${{ env.RELEASE_BRANCH }}
path: ./radius
token: ${{ secrets.GH_RAD_CI_BOT_PAT }}
- name: Setup Go ${{ env.GOVER }}
uses: actions/setup-go@v2
with:
go-version: ${{ env.GOVER }}
- name: Setup Node
uses: actions/setup-node@v2
with:
Expand All @@ -58,29 +55,6 @@ jobs:
sudo npm install -D --save postcss-cli
cd themes/docsy
npm install
- name: Restore CLI Docs Cache
uses: actions/cache@v3
id: cli_cache
with:
path: |
./docs/content/reference/cli
key: ${{ runner.os }}-cli-${{ hashFiles('radius/pkg/cli') }}
- name: Restore Go Modules Cache
uses: actions/cache@v3
if: steps.cli_cache.outputs.cache-hit != 'true'
with:
path: |
~/.cache/go-build
~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('radius/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Generate CLI Docs
run: |
if [ ! -f ./docs/content/reference/cli/rad.md ]; then
cd radius
go run ./cmd/docgen/main.go ../docs/content/reference/cli
fi
- name: Generate Swagger docs
run : |
mkdir -p ./docs/static/swagger
Expand All @@ -89,7 +63,7 @@ jobs:
run: |
cd docs
if [ $GITHUB_EVENT_NAME == 'pull_request' ]; then
STAGING_URL="https://${SWA_BASE}-${{github.event.number}}.westus2.azurestaticapps.net/"
STAGING_URL="https://${{ vars.ENV_STATICWEBAPP_BASE }}-${{github.event.number }}.westus2.3.azurestaticapps.net/"
fi
hugo ${STAGING_URL+-b "$STAGING_URL"}
- name: Upload Hugo artifacts
Expand All @@ -100,13 +74,13 @@ jobs:
if-no-files-found: error

deploy:
name: Deploy Hugo Website
name: Deploy Hugo Website to App Service
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
needs: ['build']
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 All @@ -131,11 +105,13 @@ jobs:
resource-group-name: ${{ vars.ENV_APPSERVICE_RESOURCEGROUP }}
package: site/

open_staging_site:
name: Open Staging Site
deploy-website:
name: Deploy Hugo Website
needs: ['build']
runs-on: ubuntu-latest
continue-on-error: true
environment:
name: ${{ github.ref_name == 'edge' && 'edge' || 'latest' }}
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 All @@ -145,7 +121,7 @@ jobs:
- name: Deploy staging site
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.STAGING_DOCS_SITE_TOKEN }}
azure_static_web_apps_api_token: ${{ secrets.ENV_STATICWEBAPP_TOKEN }}
repo_token: ${{ secrets.GITHUB_TOKEN }}
action: "upload"
app_location: "site/"
Expand Down Expand Up @@ -174,12 +150,15 @@ jobs:
name: Close PR Staging Site
if: github.event_name == 'pull_request' && github.event.action == 'closed'
runs-on: ubuntu-latest
environment:
name: ${{ github.ref_name == 'edge' && 'edge' || 'latest' }}
url: ${{ github.ref_name == 'edge' && 'https://edge.docs.radapp.io' || 'https://docs.radapp.io' }}
steps:
- name: Close Pull Request
id: closepullrequest
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.STAGING_DOCS_SITE_TOKEN }}
azure_static_web_apps_api_token: ${{ secrets.ENV_STATICWEBAPP_TOKEN }}
action: "close"

algolia_index:
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/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
17 changes: 11 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,15 +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 @@ -80,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
Loading

0 comments on commit d4f7444

Please sign in to comment.