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

Some text updates to intro section #26

Merged
merged 7 commits into from
Jun 2, 2015
Merged

Some text updates to intro section #26

merged 7 commits into from
Jun 2, 2015

Conversation

rmglennon
Copy link
Contributor

Filled in the to do items on API key, bugs/issues, service limits from @kdiluca. (This is still in progress, just doing an initial check in.)

@dnesbitt61
Copy link
Member

:shipit:


We hope to relax the limits on route distance as we improve performance on longer routes. The limit of number of locations will be increased shortly, stay tuned.
Send a message if you need higher limits in the meantime.
Copy link
Member

Choose a reason for hiding this comment

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

might want to reiterate where you want the message to be sent

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thinking this should be an email, rather than a GitHub issue...will add the address here.

@kevinkreiser
Copy link
Member

looks good

@rmglennon
Copy link
Contributor Author

Thanks @kevinkreiser (and @dnesbitt61 for the merge/shipit squirrel). Will look at these notes and the restrictions section (hadn't gotten through that part yet!). I took out some of the intro stuff and will put it elsewhere, too. Just wanted to get the limits updated.

@kdiluca
Copy link
Member

kdiluca commented May 28, 2015

It would probably be nice to show an example of a simple request. I have this one saved for a route that avoids Canada by using the country_crossing_penalty:

http://valhalla.api.dev.mapzen.com/route?json={"locations":[{"lat":42.358528,"lon":-83.271400,"street":"Appleton"},{"lat":42.996613,"lon":-78.749855,"street":"Ranch Trail"}],"costing": "auto","costing_options":{"auto":{"country_crossing_penalty":2000.0}},"directions_options":{"units":"miles"}}&api_key=

@rmglennon
Copy link
Contributor Author

Thanks, @kdiluca! There is a section on sample requests. I added this one (will need to be updated without the dev URL).

Update: added this explanation for this particular route (commit 3): This request provides automobile routing between the Detroit, Michigan area and Buffalo, New York, with an optional street name parameter to improve navigation at the start and end points. It attempts to avoid routing north through Canada by adding a penalty for crossing international borders. The resulting route is displayed in miles.

rmglennon added 4 commits May 28, 2015 17:24
Moved unordered lists into tables, cleaned up text, added links to OSM
tags, ordered costing options, added bicycle options. To do: get
started, fix heading hierarchy, output section
Removed section on rate limitations per second/day (following
discussion check in meeting), formatting of JSON output section
Added route return examples, removed compatibility mode, updated URLs,
improved table cell alignment, added code formatting
@rmglennon
Copy link
Contributor Author

OK, think this addresses all the "to do" items, as well as updated formatting and some rewrites. Take a look and see if these changes can be merged. Thanks!

@kevinkreiser
Copy link
Member

we dont currently support pbf output but it is planned. might want to also name this out_format to match the other parameter names. i would also favor the values without the '.' for this. anyway, this is sweet. SHIP SHIP SHIP

indicating that pdf and sos are not yet supported.
@kevinkreiser
Copy link
Member

:shipit:

rmglennon added a commit that referenced this pull request Jun 2, 2015
Some text updates to intro section
@rmglennon rmglennon merged commit 23a1767 into master Jun 2, 2015
@rmglennon rmglennon deleted the demo-doc-updates branch June 2, 2015 20:24
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.

4 participants