Mention Deployment in README

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

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
kubernetes
Domain
documentation

Research direction

Start with the README's existing DaemonSet installation instructions and compare them with k8s/deployment.yaml. Update the README to clearly highlight that a Deployment variant is available, then verify that the installation guidance accurately points readers to both options.

Written by the indexing model from the issue text.

Description

Our README describes how the Daemonset can be installed. We also have a Deployment variant that is
a bit non-obvious to find.

We should amend the README to highlight the availability of the Deployment as well.

Refs #21.

Dominant language
Dockerfile
Stars
169
Forks
36
Avg merge
6d 20h
Merged PRs (30d)
1

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.

More from digitalocean/doks-debug

All issues in digitalocean/doks-debug

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.