Skip to content

Commit

Permalink
Merge branch 'v0.26' into aacrawfi/faq
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronCrawfis committed Oct 30, 2023
2 parents 7b303fe + a2a6036 commit ecaff31
Show file tree
Hide file tree
Showing 17 changed files with 790 additions and 31 deletions.
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
69 changes: 69 additions & 0 deletions .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -981,3 +981,72 @@ SREs
OSI
ghcr
sharding
png
src
todoapp
todolist
mockup
diataxis
appdiagram
tmp
jpg
buildingblocks
svg
ClusterIP
NodePort
replicaset
radified
cd
ddgq
dfc
fh
qd
vf
zht
interoperate
ToDo
dfb
vhj
Helming
mv
secretName
bcd
jmgn
xgj
Fs
FsOjYzNzksYWJvcnRDb
JyYTNkN
LmRlbW
Ly
NjM
OQ
PUZhbHNl
VoNi
Yy
ZXIubG
ZjLmNsdXN
ZmFsc
bea
blockOwnerDeletion
cb
cmVkaXM
cmVkaXMtcjV
creationTimestamp
dWg
fb
jYWw
jbHVzdGVyLmxvY
kZW
ownerReferences
resourceVersion
uZWN
uc
uid
vLnN
wPw
yNXRjcnJhM
yZWRpcy
matchLabels
plc
cdf
dcf
6 changes: 0 additions & 6 deletions .github/workflows/validate-bicep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@ jobs:
steps:
- name: Check out repo
uses: actions/checkout@v2
- name: az CLI login
run: |
az login --service-principal \
--username ${{ secrets.AZURE_SP_TESTS_APPID }} \
--password ${{ secrets.AZURE_SP_TESTS_PASSWORD }} \
--tenant ${{ secrets.AZURE_SP_TESTS_TENANTID }}
- name: Parse release version and set environment variables
run: python ./.github/scripts/get_docs_version.py
- name: Download rad-bicep
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ jobs:
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.ENV_STATICWEBAPP_TOKEN }}
skip_deploy_on_missing_secrets: true
action: "close"

algolia_index:
Expand Down
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# Contributing to Radius documentation

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/)

## Developer Certificate of Origin

The Radius project follows the [Developer Certificate of Origin](https://developercertificate.org/). This is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.

Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

```
This is my commit message
Signed-off-by: Random J Developer <[email protected]>
```

Git even has a -s command line option to append this automatically to your commit message:

```
$ git commit -s -m 'This is my commit message'
```

Visual Studio Code has a setting, `git.alwaysSignOff` to automatically add a Signed-off-by line to commit messages. Search for "sign-off" in VS Code settings to find it and enable it.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The latest release docs are available at https://radapp.io

### Edge docs

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

### Staging docs

Expand Down
2 changes: 1 addition & 1 deletion docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Radius is a cloud native application platform. It enables developers and IT ope
{{< /card >}}
{{< /cardpane >}}
{{< cardpane >}}
{{< card header="**💭 Concepts**" footer="[**Learn the concepts →**]({{< ref tutorials >}})" >}}
{{< card header="**💭 Concepts**" footer="[**Learn the concepts →**]({{< ref concepts >}})" >}}
Learn about the background and concepts behind Radius with in-depth explanations. We'll cover the main concepts and how Radius works, so you have the broader context to deeply understand Radius and use it most effectively.
{{< /card >}}
{{< card header="**🧾 Reference**" footer="[**Visit reference material →**]({{< ref guides >}})" >}}
Expand Down
20 changes: 20 additions & 0 deletions docs/content/community/contributing/contributing-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,26 @@ It's easy to get up and running with a GitHub Codespace. This will give you a fu

3. Navigate to `http://localhost:1313/`

## Developer Certificate of Origin

The Radius project follows the [Developer Certificate of Origin](https://developercertificate.org/). This is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.

Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

```
This is my commit message
Signed-off-by: Random J Developer <[email protected]>
```

Git even has a -s command line option to append this automatically to your commit message:

```
$ git commit -s -m 'This is my commit message'
```

Visual Studio Code has a setting, `git.alwaysSignOff` to automatically add a Signed-off-by line to commit messages. Search for "sign-off" in VS Code settings to find it and enable it.

## Types of docs

There are 5 types of docs in Radius:
Expand Down
8 changes: 4 additions & 4 deletions docs/content/guides/recipes/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Recipes enable a **separation of concerns** between infrastructure operators and

### Support for multiple IaC languages

| Infrastructure as Code Languages | Recipe Support |
|---------------------| ------------|
| [Bicep](https://learn.microsoft.com/azure/azure-resource-manager/bicep/) ||
| [Terraform](https://developer.hashicorp.com/terraform/docs) ||
| Language | Recipe Support | Notes |
|----------| ---------------|-------|
| [Bicep](https://learn.microsoft.com/azure/azure-resource-manager/bicep/) | ✅ | Supports Azure, AWS, and Kubernetes
| [Terraform](https://developer.hashicorp.com/terraform/docs) | ✅ | Supports Azure, AWS, and Kubernetes providers<br />Other providers not yet configurable

### Select the Recipe that meets your needs

Expand Down
Binary file added docs/content/tutorials/helm/demo-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/tutorials/helm/diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit ecaff31

Please sign in to comment.