cartographer icon indicating copy to clipboard operation
cartographer copied to clipboard

Update Deliverable .spec.source description to match use case

Open waciumawanjohi opened this issue 2 years ago • 3 comments

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

waciumawanjohi avatar Feb 18 '22 16:02 waciumawanjohi

Thanks for creating this! Not in scope here, but a suggestion for some future docs would be an end-to-end diagram showing a build cluster using SupplyChains and Workloads and ultimately pushing to the git repo. Then some run clusters using the Delivery/Deliverable resources to pull and run this. I think the examples are a step in the right direction, but that something visual would help me picture it all better. 👍

tcdowney avatar Feb 18 '22 18:02 tcdowney

Is this the diagram you were hoping for? If so, sounds like we should do a better job of surfacing it (maybe just link it in the examples).

waciumawanjohi avatar Feb 18 '22 18:02 waciumawanjohi

Yeah actually, that's pretty much it. 😁 I didn't think to click on "Architecture" on the side. I think maybe some more direct "Concepts and Usage" linking or tutorials or something would help. Linking to it from the examples would be helpful as well. 👍

tcdowney avatar Feb 18 '22 18:02 tcdowney