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 docs on request and deploy concepts #922

Merged
merged 1 commit into from Feb 26, 2016
Merged

add docs on request and deploy concepts #922

merged 1 commit into from Feb 26, 2016

Conversation

ssalinas
Copy link
Member

@tpetr
Copy link
Contributor

tpetr commented Feb 25, 2016

Could be good to get @markhazlewood's eyes on this too

@tpetr
Copy link
Contributor

tpetr commented Feb 26, 2016

I kind of have a nitpick with the first person tone (doesn't match the test of the docs), but beside that, LGTM

@ssalinas
Copy link
Member Author

Updated to sound more like the docs in examples.md



### Creating a `Request`
You have a new web service called `TestService` that you want to run via Singularity. The first thing you need to do is create a `Request` for `TestService`. To create this request, you would `POST` json over http to the Singularity API or create a request via the new request page in the Singularity UI. Example json:
Copy link
Contributor

Choose a reason for hiding this comment

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

may want to include the endpoint (.../api/requests) or a link to the API reference doc for creating the request

@tpetr
Copy link
Contributor

tpetr commented Feb 26, 2016

LGTM

ssalinas added a commit that referenced this pull request Feb 26, 2016
add docs on request and deploy concepts
@ssalinas ssalinas merged commit e1fe715 into master Feb 26, 2016
@ssalinas ssalinas deleted the request_docs branch Feb 26, 2016
@ssalinas ssalinas modified the milestone: 0.4.12 Apr 1, 2016
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.

None yet

2 participants