vmware-tanzu/cartographer

Update Deliverable .spec.source description to match use case

Open

#647 opened on Feb 18, 2022

View on GitHubContributor guide
 (3 comments) (1 reaction) (0 assignees)Go (64 forks)auto 404
documentationgood first issue

Repository metrics

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

Description

Description of problem

The deliverable expects to receive k8s configuration through a gitops workflow. Hence it has a .spec.source field. But the current description states that this should be source code.

Proposed solution

Update the description

Given I am a new Carto user
When I read the deliverable CRD doc
Then I understand the use case for this field

TODO:

  • Generate the docs

Contributor guide

Research direction
Locate the description in deliverable.go, update it to reflect gitops workflow, and regenerate the CRD docs.
Tech stack
go
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
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.
85