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.

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

Using kubernetes-mixin as a base, add a README. #1

Merged
merged 4 commits into from
Nov 16, 2018
Merged

Conversation

tomwilkie
Copy link
Member

@tomwilkie tomwilkie commented Nov 15, 2018

Signed-off-by: Tom Wilkie <[email protected]>
Signed-off-by: Tom Wilkie <[email protected]>
@brancz
Copy link
Member

brancz commented Nov 15, 2018

The design as a pdf seems kind of odd, why not markdown?

@brancz
Copy link
Member

brancz commented Nov 15, 2018

I just cross read, but this lgtm in my experience this will improve over time anyways as the community contributes things that are unclear where we are likely too close to the concept to realize.


```
$ go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
$ brew install jsonnet

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO we should not only show how to brew install here


```
$ go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb
$ brew install jsonnet

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just found that nobody really has official support yet. Maybe linking to AUR is ok, but also not as important then.

Suggested change
$ brew install jsonnet
# macOS
$ brew install jsonnet
# Archlinux AUR
$ yay -S jsonnet

Copy link

@metalmatze metalmatze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
I'm also not sure about the PDF file though. Maybe markdown with a link to the original is good enough.

Signed-off-by: Tom Wilkie <[email protected]>
@tomwilkie
Copy link
Member Author

PDF because its a google doc, and there is no export as markdown. Plus that design is kinda immutable now - future changes should be new designs IMO.

@tomwilkie tomwilkie merged commit acc57c0 into master Nov 16, 2018
@tomwilkie tomwilkie deleted the initial-docs branch November 16, 2018 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants