oracle/cluster-api-provider-oci

Add documentation for help debug cluster api tags modified out of context

Open

#148 opened on Sep 13, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (48 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (55 stars)
PR merge metrics
 (PR metrics pending)

Description

What would you like to be added:

  • Add documentation for help debug cluster api tags modified out of context
  • Modify error messages to point to the doc

Why is this needed:

Contributor guide

Research direction
Explore the codebase to find where error messages related to cluster API tags are generated, then draft documentation explaining common causes and debugging steps. Update the error messages to reference the new documentation.
Tech stack
go
Domain
infrastructurecloud
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75