search

mapzen / documentation

Configuration files, tools, and content to build Mapzen's documentation
https://mapzen.com/documentation
MIT License
25 stars 22 forks source link

Create new Mobility section and redirect existing docs into it #181

Closed migurski closed 8 years ago

migurski commented 8 years ago

Closes #180.

rmglennon commented 8 years ago

Confirmed, the "Edit this page" links in our renamed files are broken. :(

404 in optimized https://precog.mapzen.com/mapzen/mapzen-docs-generator/rhonda-new-mobility/documentation/mobility/optimized/api-reference/ --> edit this page goes to https://github.com/valhalla/valhalla-docs/tree/master/optimized/api-reference.md --> correct location (optimized_route) https://github.com/valhalla/valhalla-docs/blob/master/optimized_route/api-reference.md

404 in turn-by-turn https://precog.mapzen.com/mapzen/mapzen-docs-generator/rhonda-new-mobility/documentation/mobility/turn-by-turn/api-reference/ --> edit this page goes to https://github.com/valhalla/valhalla-docs/tree/master/turn-by-turn/api-reference.md --> correct location (no turn-by-turn) https://github.com/valhalla/valhalla-docs/tree/master/api-reference.md

migurski commented 8 years ago

Cheap and easy fix: link to the top of the documentation section on Github and let people figure out what to edit.

Harder fix: track the files we are renaming and ensure the links go to the right places.

migurski commented 8 years ago

I think I’ve fixed this. The only new twist is that mz:renames now must use filenames instead of directory names, so that the renaming can be found in the template.

rmglennon commented 8 years ago

Hooray, looks good so far...will do some testing.

rmglennon commented 8 years ago

New thing...@kkowalsky found that images are broken links. The only topic with images is documentation/mobility/turn-by-turn/add-routing-to-a-map/, but I'd assume it'd be a problem with any of them.

Broken link example: documentation/mobility/turn-by-turn/images/browser-controls.png

I'm not yet sure where the images actually live...still looking.

rmglennon commented 8 years ago

Remaining items are content-related and will be done in the valhalla-docs repository.