radius-project / radius-project/docs

Add Kubernetes and Helm annotations feature documentation

Open
#1,117 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

What content needs to be created or modified?

Today, Radius has a feature where the user may add Radius to their existing Kubernetes/Helm applications via annotations in the Kubernetes YAML files. However, the feature is not documented in any of the guides or concept pages, and only appears in the Kubernetes and Helm tutorials:

Describe the solution you'd like

The Radius supported features for Kubernetes YAML Annotations should be documented as features in addition to existing mentions in the tutorials.

Where should the new material be placed?

Suggestion is to put this content in the containers overview page.

This new content should then be cross-linked in the relevant tutorials:

The associated pull request from the Radius code repo, if applicable

n/a

Additional context

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 with the containers overview page and the existing Kubernetes and Helm tutorials linked in the issue. Identify the supported Kubernetes YAML annotation features already described there, document them on the overview page, and cross-link the relevant tutorials so the material is discoverable from all three locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.