Sync code layout section in doc with repo layout #735
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
dev-drprasad
requested review from
carolynvs,
jeremyrickard and
vdice
as code owners
vdice
approved these changes
Oct 16, 2019
There was a problem hiding this comment.
👍 NIce cleanup!
I wonder if the high-level code layout (perhaps all directory names?) can be auto-generated? Noticing already that we'd want to update the list under pkg with new dirs such as manifest, instance-storage, etc. cc @carolynvs
|
One thing we can start doing is using a doc.go file in our code and explaining in the code what each package is for. I didn't document every single package in contributing because not all are of the same importance and I figured it would be noisy. If we could eventually refer people to godoc that would be better perhaps? |
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.
What does this change
Lot of directories are now not in root level. They moved to
pkgdirectory. This change syncs doc with repo layoutCurrent Layout
New layout
Notes for the reviewer
I hope we don't need extra whitespaces :)