Improve documentation: before and after image #1696
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To gather feedback, I intend to improve and make .svg with transparent background and a light version too
Dark mode only
ivakoleva
approved these changes
Mar 2, 2023
gageorgiev
reviewed
Mar 2, 2023
duyguHsnHsn
reviewed
Mar 2, 2023
There was a problem hiding this comment.
I love the photos but I think it is hard to read "data sources" in the second one. And why are they placed in one place?
Isn't the idea that they can be in different places but still will be pointing all to VDK and not as the first one pointing to different places
|
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
Is the .svg only for dark mode? I think some of the text won't be visible in light mode. |
duyguHsnHsn
approved these changes
Mar 6, 2023
|
Please explain in the PR description, why are doing this change, what is the goal of the before and after image. If this explanation is available in a github issue, you can leave it in the github issue (provide link). please link the github issue from which this PR comes in any case. As are reminder see https://github.com/vmware/versatile-data-kit/blob/main/support/git-commit-template.txt |
Upload 3 versions of the image with and without VDK light version and transparent background
for more information, see https://pre-commit.ci
One image version explaining VDK with red and blue text
for more information, see https://pre-commit.ci
It was decided to stay with the black text only.
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
ivakoleva
pushed a commit
that referenced
this pull request
Mar 9, 2023
From the problem definition interviews: _- The image is confusing (VDK before/after)._ _- If I'm an engineer, I don't think in terms of teams - Data Team / Infra team._ _- If I have no data background, it will not support me in understanding the framework. _ Instead of bringing clarity, the images are confusing for potential users. Solution: Use simple language and make the benefits of the Versatile Data Kit clear for everyone in the images Images created/edited: - Image of Without VDK vs. With VDK (problem/solution) - Image of Without VDK vs. With VDK (code) --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From the problem definition interviews:
- The image is confusing (VDK before/after).
- If I'm an engineer, I don't think in terms of teams - Data Team / Infra team.
- If I have no data background, it will not support me in understanding the framework.
Instead of bringing clarity, the images are confusing potential users.
Solution: Use simple language and make the benefits of the Versatile Data Kit clear for everyone in the images
Images created/edited: