Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Update README within examples #251

Merged

Conversation

cdrage
Copy link
Collaborator

@cdrage cdrage commented Sep 6, 2017

This makes the examples simpler by making them one file as well as
updating the README's to a full description of how to use said example.

Copy link
Member

@surajssd surajssd left a comment

Choose a reason for hiding this comment

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

I don't think we want to promote that approach of defining applications with kedge!

@cdrage
Copy link
Collaborator Author

cdrage commented Sep 7, 2017

I believe that we are supporting single-file and multiple-file. For a real-world example, it seems simpler to have it in one. Enterprise, etc would be good with multiple. Thoughts @kadel @pradeepto @containscafeine ?

@concaf
Copy link
Collaborator

concaf commented Sep 7, 2017

@cdrage we support both because this feature was requested, but we don't encourage using it, and hence follow the best practices in our examples. Refer to discussion on #17.

@cdrage
Copy link
Collaborator Author

cdrage commented Sep 7, 2017

@containscafeine ah darn, I'll split them back up to multiple files then.

@cdrage cdrage force-pushed the make-examples-one-file-and-detailed branch from cff011d to f5e4ad1 Compare September 7, 2017 19:46
@cdrage
Copy link
Collaborator Author

cdrage commented Sep 7, 2017

@containscafeine @surajssd gone ahead and updated the PR with multiple-files rather than a single kedge file.

Copy link
Member

@surajssd surajssd left a comment

Choose a reason for hiding this comment

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

LGTM!

@surajssd
Copy link
Member

surajssd commented Sep 8, 2017

before merge @cdrage can you update the commit to be according to changes we have made now ?

@cdrage cdrage changed the title Single files for examples, update README Update README within examples Sep 8, 2017
Updates the README with full descriptions as well as change the default
file extenssion to .yaml instead of .yml
@cdrage cdrage force-pushed the make-examples-one-file-and-detailed branch from f5e4ad1 to 9920332 Compare September 8, 2017 12:29
@cdrage
Copy link
Collaborator Author

cdrage commented Sep 8, 2017

@surajssd done

@surajssd surajssd merged commit 316366c into kedgeproject:master Sep 8, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants