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

Replace API documentation redirect with redirect-from #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

1ec5
Copy link
Member

@1ec5 1ec5 commented Aug 10, 2017

#10 didn’t work, because it depends on a publishing tool that isn’t present on GitHub Pages. Instead, this PR uses a whitelisted jekyll plugin to create the redirect. I’ve tested this locally to verify that it works with jekyll.

Each time a new release is published, redirect_from must be removed from the old version and added to the new version. Alternatively, we could have index.html be a simple HTML page with a meta redirect. @danpat @daniel-j-h, which approach would you prefer?

@1ec5 1ec5 self-assigned this Aug 10, 2017
@1ec5 1ec5 requested review from danpat and daniel-j-h August 10, 2017 04:25
@daniel-j-h
Copy link
Member

Alternatively, we could have index.html be a simple HTML page with a meta redirect.

Hm both require a bit of manual twiddling, the best solution would be to have Travis build the api docs from the osrm package and publish them here. I'm fine with both solutions in the meantime - we should document it.

@danpat
Copy link
Member

danpat commented Aug 10, 2017

Yeah, we should publish the docs automatically and do some sed magic to update links. Project-OSRM/osrm-backend#4395

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.

3 participants