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.

Sign up for GitHub

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

Jump to bottom

Add complete, runnable examples in README/wiki #33

Open
apostergiou opened this issue Apr 15, 2018 · 2 comments
Open

Add complete, runnable examples in README/wiki #33

apostergiou opened this issue Apr 15, 2018 · 2 comments
Assignees
@apostergiou
Labels
documentation

Comments

@apostergiou
Copy link
Contributor

apostergiou commented Apr 15, 2018 •
edited

These would demonstrate the complete flow and would contain real flags. For example:

$ mistry-cli --project rails --group staging --target /tmp

# ... server output

# ... synced artifacts
@agis agis added this to the 1.0 milestone Apr 17, 2018
@agis
Copy link
Contributor

agis commented Apr 17, 2018

It would be great if someone could just clone the repo (or go get it) and then follow some steps and actually schedule a job. We could provide a sample project inside the repo (perhaps in testdata).

@agis agis changed the title Add complete examples in README/wiki Add complete, runnable examples in README/wiki Apr 17, 2018
@apostergiou
Copy link
Contributor Author

I will work on this, for starters we could add an Examples paragraph in README.

@apostergiou apostergiou self-assigned this May 28, 2018
apostergiou added a commit that referenced this issue May 29, 2018
@apostergiou
README: Add complete, runnable examples
b995ebb 
Closes #33
@apostergiou apostergiou mentioned this issue May 29, 2018
Closed
apostergiou added a commit that referenced this issue May 30, 2018
@apostergiou
README: Add complete, runnable examples
4e880b5 
Closes #33
apostergiou added a commit that referenced this issue Jun 4, 2018
@apostergiou
README: Add complete, runnable examples
cf5a187 
Closes #33
apostergiou added a commit that referenced this issue Jun 4, 2018
@apostergiou
README: Add complete, runnable examples
04dd284 
Also, introduces _examples directory that can be used to hold the source
code for usage examples. For starters, it will contain a bundler project
which builds Ruby gems.

Closes #33
@agis agis removed this from the 1.0 milestone Nov 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@apostergiou apostergiou

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@agis @apostergiou