varnish / varnish/orca

Docs: installation.md is missing Helm instructions

Open Beginner friendly
#7 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
43
Forks
1
PR merge metrics
No merged PRs in 30d

Description

It would be good to have a quick getting started guide for Helm in https://github.com/varnish/orca/blob/main/docs/installation.md. For full Helm chart docs and source, the reader can be referred to https://github.com/varnish/helm-varnish/tree/main/orca-chart

Contributor guide

No contributing guide indexed for this repository

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

Open docs/installation.md and use the linked orca-chart documentation and source as the reference for the Helm setup. Add a concise getting-started guide and link readers to the full chart documentation; the work is done when installation.md explains the basic Helm path and points to the chart repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.