Azure / Azure/orkestra

Developer docs are out of date and need to be updated

Open
#391 0 comments 0 reactions 0 assignees View on GitHub
chore
Dominant language
Go
Stars
112
Forks
21
PR merge metrics
No merged PRs in 30d

Description

**Describe the bug**
Developer docs are not up to date.

- [ ] Debugging : we now utilitze on `make dev` along with `delve` to debug our control plane. The `make dev` target creates a KinD cluster with the orkestra controller disabled. End-user can either step through using a debugger like `delve` or start the process locally using `make debug`. We no longer require okteto, Azure bridge-for-kubernetes or Tilt for debugging.
- [ ] Directory structure table out of date.

Contributor guide

Open the contributing guide

Research direction

Locate the developer debugging documentation and the directory structure table mentioned in the issue. Compare the instructions with the current make dev and make debug targets, including KinD, delve, and the obsolete debugging tools; done means both documentation sections accurately describe the current workflow and structure.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.