Fix documentation after code changes #516
Conversation
There was a problem hiding this comment.
there is a couple of issues with this change
- there is another PR is collides with... if we need a change we should just suggest it there
- it is misleading IMO to refer to
pkg/kudoctl/bundle/testdata/zkor it's previous content... this is testdata and not for user examples IMO.
|
@kensipe I agree with 1, I think no docs changes should be merged until we resolve that. I don't agree with 2. I find it pretty nice that there is a working example that one can run from root of the project. It could have been totally made up file path or one that actually means something in the project. I went the second way. If we don't like it, we can still pretend it's made up path :) I just changed it... |
|
Doesn't it make more sense to use a samples folder for user facing samples tho... instead of test/data? |
|
@kensipe I see your point. My reasoning was that this way it's less yaml to maintain, plus you know this yaml works because we always exercise it in tests. It's like the jsons we have in marathon - we use them in tests and they are good documentation at the same time. I was looking at this in the same way I agree that the location of those samples is not very straightforward :( but I hope we won't shuffle folders that much anymore |
No description provided.