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

Change the Android docs to use a release #257

Closed rmglennon closed 7 years ago

rmglennon commented 7 years ago

This makes the Android docs use a release, rather than a master source.

I copied the build steps for tiles, which should be done the same way, and it appears to be working: https://precog.mapzen.com/mapzen/documentation/rhonda-android-release/documentation/android/

I wasn't able to get iOS working like this because it's in a prerelease state in GitHub, but I can continue poking at GitHub's API...

cc @ecgreb - I don't think there is anything you need to do in the Android repo, other than be sure to move your docs into the release when you want them published...but we need to test!

ecgreb commented 7 years ago

👍

We will be able to test soon when we release version 1.3.0-rc1 of the android sdk and places API.

ecgreb commented 7 years ago

@rmglennon if the pre-release tag on iOS is preventing docs from picking it up in this way we can always drop it. I think having a version number of 0.x.x sends the same signal to potential developers.

rmglennon commented 7 years ago

Yep, @ecgreb - the latest endpoint does not return prereleases.

https://developer.github.com/v3/repos/releases/#get-the-latest-release

So, for iOS, looks like the options for docs are either 1) keeping them on master while in prerelease state, 2) keeping a prerelease state and updating the doc build scripts to change the release number each time we want to push out new docs, or 3) removing the prerelease tag on the iOS side. Removing the prerelease tag is simplest for doc maintenance, but I'm happy to do whatever works best for your users!

rmglennon commented 7 years ago

iOS changed to use releases, too

ecgreb commented 7 years ago

👍