Skip to content
radius-projectPublic

Latest commit

 

History

1,510 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📕 Radius documentation

This repo contains the source for the Radius documentation.

📦 Framework

Radius uses Hugo to generate the docs site.

Theme

The Docsy theme is used to style the generated site.

Auto-generated docs

The rad CLI reference docs are auto-generated via Cobra doc gen.

👨‍💻 Contributing

Visit the docs contribution guide to learn how to contribute to the docs.

Build or serve locally

The repository root is the Hugo project. Use the Node.js version in .node-version and Go as specified in go.mod. From the root:

npm ci
npm start

Open the URL printed by Hugo. In a Codespace, the container runs npm ci for you. To build the static site instead, run npm run build; Hugo writes it to public/.

The lockfile supplies Hugo and Dart Sass; no global installation is needed. After updating Docsy in go.mod, run npm run hugo -- mod npm pack and npm install to refresh the theme workspace and lockfile. The adm-zip override pins the Hugo installer's patched ZIP reader on Windows; remove it once hugo-extended requires a patched version.

☁ Hosting

The Publish workflow deploys one GitHub Pages artifact with two versions:

  • latest is the newest stable vMAJOR.MINOR docs branch, selected by version number. A branch whose chart_version is still a release candidate does not become latest.
  • edge follows the default edge branch.

URLs without a channel open the corresponding stable page: / opens /latest/, and /installation/ opens /latest/installation/. Unversioned downloads such as /samples/demo/app.bicep serve the stable file directly. The Docsy menu shows edge or latest (X.Y) using the release branch's version. Switching keeps the current page when it exists in both channels.

The core Radius release process dispatches Release docs on edge for a final release. That workflow creates the vMAJOR.MINOR docs branch without changing the default branch.

Pushes to edge rebuild both versions. A push or merged pull request on a release branch triggers the same publisher through Website, including on branches cut before this migration. The publisher reads the current tip of the newest stable branch, not the commit that cut the release. A typo fix on that branch therefore updates /latest/ and the unversioned URLs without a new tag or a merge into edge. A fix on an older branch does not change which branch serves /latest/.

Publish also rebuilds daily at 16:17 UTC to catch changes for which GitHub didn’t emit a push workflow run. To rebuild manually, run it on edge. Pull requests to either published branch get a downloadable docs-preview-* artifact; extract it and run python -m http.server 8000 from the extracted directory. Pull requests never deploy to Pages.

For the first deployment, set Settings → Pages → Source to GitHub Actions and allow edge in Settings → Environments → github-pages → Deployment branches and tags. The workflow reads the host and base path from actions/configure-pages, so the version menu, assets, and page links follow the configured domain without a workflow edit. Only deployments to docs.radapp.io update the production Algolia indices; previews use Docsy's per-version search.

Previously cut branches retain their original site layout and workflows. The publisher locates their Hugo project in docs/ and uses the pinned theme and Sass tools from edge for pre-migration releases without changing their content. Backport the replacement website.yaml to a maintained release branch to stop its old Azure publisher; keep the workflow name so its pushes still notify Pages.

Code of Conduct

Please refer to our Radius Community Code of Conduct

Used by

Contributors

Languages