radius-project / radius-project/docs
Author installation docs for scripts/non-human installations
Nobody has claimed this yet.
- 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:
- Do a once over of https://docs.radapp.io/guides/deploy-apps/howto-deploy/howto-deploy-cicd/ to make sure it's up to date and accurate
- Create a friendlier alias for the above page. Something like https://docs.radapp.io/install/script
- Update the
rad initlong description to include information about unattended installation, and have a link to the page in the docs (the shorter version) - Update the installation page with a link to the unattended version.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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