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

Add some documentation and examples #9

Merged
merged 2 commits into from
Jun 4, 2018
Merged

Add some documentation and examples #9

merged 2 commits into from
Jun 4, 2018

Conversation

f-f
Copy link
Member

@f-f f-f commented Jun 2, 2018

I rewrote the README and added some examples. Should fix #3.

In the end I didn't go for an examples folder with all the examples, but embedded them in the README, for consistency with all the other repos around here (also they are much more discoverable).

@arianvp how does it sound?

@f-f f-f requested a review from arianvp June 2, 2018 20:46
@arianvp
Copy link
Member

arianvp commented Jun 4, 2018

LGTM!

Perhaps we should add a comparison to competitors later on. For example, Dhall seems like a way more disciplined alternative to https://github.com/kubernetes/helm

@f-f
Copy link
Member Author

f-f commented Jun 4, 2018

Thanks! I agree with adding a comparison with competitors, I opened an issue to track it.
I used helm just briefly, definitely not enough to write down a comparison. Over here we're not using it because of the complexity (we have a small cluster) and security concerns. For templating so far we've been using Jinja.

@f-f f-f merged commit dd2515c into master Jun 4, 2018
@f-f f-f deleted the f-f/add-readme branch June 4, 2018 09:57
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.

Add a bit of documentation + some examples
2 participants