Skip to content

Commit

Permalink
Merge pull request #310 from kkowalsky/patch-1
Browse files Browse the repository at this point in the history
add 'where the docs live'
  • Loading branch information
rmglennon authored Sep 19, 2016
2 parents d089e44 + 6408d02 commit 77b0d5c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions src/site/guides/doc-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,23 @@ This site brings together all Mapzen's documentation in one place. The underlyin

As long as a markdown file is listed in the build configuration, changes you make to the source files in the GitHub branch that is being pulled into the help (typically, the master branch) appear automatically on https://mapzen.com/documentation.

## Where do the docs live?

Docs live in either individual repositories in a team's organization, or as a folder in a project's repository. Also, depending on the config of the docs, doc updates may be as simple as pushing to master or need to be in a release.

| Product | Where does it live? | Updates |
|----------------------------------------------------------|---------------------|----------|
| [Overview](http://www.mapzen.com/documentation/overview) | https://github.com/mapzen/mapzen-docs-generator/tree/master/docs | Push to Master |
| [Mapzen.js](https://mapzen.com/documentation/mapzen-js/) | https://github.com/mapzen/mapzen.js/tree/master/docs | Needs to be in a release |
| [Tangram](https://mapzen.com/documentation/tangram/) | https://github.com/tangrams/tangram-docs | Push to gh-pages |
| [Vector Tiles](https://mapzen.com/documentation/vector-tiles/) | https://github.com/tilezen/vector-datasource/tree/master/docs | Has versioning |
| [Search](https://mapzen.com/documentation/search/) | https://github.com/pelias/pelias-doc | Push to Master |
| [Mobility](https://mapzen.com/documentation/mobility/) | https://github.com/valhalla/valhalla-docs | Push to Master |
| [Metro Extracts](https://mapzen.com/documentation/metro-extracts/) | https://github.com/mapzen/metro-extracts/tree/master/docs | Push to Master |
| [Terrain Tiles](https://mapzen.com/documentation/terrain-tiles/) | https://github.com/tilezen/joerd | Push to Master |
| [Elevation Service](https://mapzen.com/documentation/elevation/) | https://github.com/valhalla/valhalla-docs | Push to Master |
| [Android SDK](https://mapzen.com/documentation/android/) | https://github.com/mapzen/android/tree/master/docs | Push to Master |

## Build and deploy the help system website

The help system is built with an open-source Python tool called [MkDocs](http://www.mkdocs.org/), which formats GitHub markdown files in to a static, HTML website. MkDocs also creates a table of contents, a simple keyword search, navigation breadcrumbs, and links to move back and forward between topics. Note that while MkDocs reads just one source, Mapzen has enhanced the generator to integrate multiple repositories. There have been additional enhancements to support URL redirects and renaming files in the output help.
Expand Down

0 comments on commit 77b0d5c

Please sign in to comment.