radius-project / radius-project/docs

Author installation docs for scripts/non-human installations

Open
#1,017 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

triaged
Dominant language
Bicep
Stars
26
Forks
52
Avg merge
3d 2h
Merged PRs (30d)
3

Description

Currently our docs our docs are optimized for interactive installation via a user's terminal. We need better docs and links for scripts/unattended installations of Radius.

There's one page we have: https://docs.radapp.io/guides/deploy-apps/howto-deploy/howto-deploy-cicd/, but we need to link to this better.

I propose we do the following:

AB#10863

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing CI/CD installation page linked in the issue for accuracy and identify the installation page and rad init long description mentioned in the checklist. Create a friendlier unattended-installation entry point, add the requested links, and verify that the documentation and CLI text consistently direct users to the unattended workflow.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.