Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix the diagram in "How It Works" ytt docs #525

Open
pivotaljohn opened this issue Aug 22, 2022 · 2 comments
Open

Fix the diagram in "How It Works" ytt docs #525

pivotaljohn opened this issue Aug 22, 2022 · 2 comments
Labels
bug This issue describes a defect or unexpected behavior carvel accepted This issue should be considered for future work and that the triage process has been completed documentation This issue indicates a change to the docs should be considered priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@pivotaljohn
Copy link
Contributor

pivotaljohn commented Aug 22, 2022 •
edited

@kevinvmware reported two potential issues regarding the diagram at the top of https://carvel.dev/ytt/docs/v0.42.0/how-it-works/#the-ytt-pipeline :

Given this paragraph:

(Configuration documents (grey, pale yellow and blue) flow through four pipeline steps (black), into evaluated intermediary documents (bright yellow and blue), and combined ultimately into plain YAML output (green).)

I think the Plain Document should be pale yellow.

... and ...

I”d also move the arrow for the Custom Data Values Files so it is to the left of the outgoing arrow to the “final Data Values” dark grey box - because then it is visually consistent with the sequence.
@pivotaljohn pivotaljohn added bug This issue describes a defect or unexpected behavior documentation This issue indicates a change to the docs should be considered carvel triage This issue has not yet been reviewed for validity labels Aug 22, 2022
@aaronshurley
Copy link
Contributor

This is great feedback. It seems like we might have a few docs-related issues that we could prioritize in the upcoming weeks/months.

@aaronshurley aaronshurley added carvel accepted This issue should be considered for future work and that the triage process has been completed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed carvel triage This issue has not yet been reviewed for validity labels Sep 13, 2022
@a-mccarthy
Copy link
Contributor

I believe this is the image to be updated: https://github.com/carvel-dev/carvel/blob/develop/site/static/images/ytt/ytt-pipeline-overview.jpg

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug This issue describes a defect or unexpected behavior carvel accepted This issue should be considered for future work and that the triage process has been completed documentation This issue indicates a change to the docs should be considered priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@aaronshurley @pivotaljohn @a-mccarthy