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 demo & usage documentation #195

Open
arschles opened this issue Sep 15, 2016 · 2 comments
Open

Add demo & usage documentation #195

arschles opened this issue Sep 15, 2016 · 2 comments
Labels
needs docs

Comments

@arschles
Copy link
Member

After #192, add documentation in doc/DEMO.md for what resources to watch and what state the cluster should be in after each action in the demo run-through
@arschles arschles added this to the Alpha 2 milestone Sep 15, 2016
@arschles arschles mentioned this issue Sep 15, 2016
Merged
@arschles
Copy link
Member Author

arschles commented Oct 6, 2016

Removing from alpha 2. Demo documentation is sufficient at this point, given https://github.com/deis/steward-demo-s3 is in order

@arschles arschles removed this from the Alpha 2 milestone Oct 6, 2016
@arschles arschles changed the title add mode-specific demo documentation Add demo & usage documentation Nov 15, 2016
@arschles
Copy link
Member Author

This issue has changed a bit. We've split steward into two components as of now:

  • steward-framework: the Go SDK for Kubernetes resource and control loops
  • steward-cf: the CloudFoundry broker API implementation on top of steward-framework

Documentation of the kind described herein should still live inside this repository, but it shouldn't just be for demos. It should be extended to general usage. I've changed the title of this issue accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
needs docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@arschles