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

Move API from AWS to GitHub Pages #397

Closed
IvanGoncharov opened this issue May 2, 2018 · 13 comments
Closed

Move API from AWS to GitHub Pages #397

IvanGoncharov opened this issue May 2, 2018 · 13 comments

Comments

@IvanGoncharov
Copy link
Member

GitHub now supports custom domains so we can move api.apis.guru to gh_pages branch of this repo:
https://blog.github.com/2018-05-01-github-pages-custom-domains-https/
Probably makes sense to deploy using Travis:
https://docs.travis-ci.com/user/deployment/pages/

@IvanGoncharov
Copy link
Member Author

@MikeRalphson What do you think?

@MikeRalphson
Copy link
Collaborator

MikeRalphson commented May 2, 2018

Sounds good. Will have a go at deploying to the gh-pages branch first and then look at switching the domain over.

@rbren
Copy link
Contributor

rbren commented May 4, 2018

FYI - I usually have an easier time deploying to the docs/ folder on the master branch. That way you can easily put your build script in package.json

@MikeRalphson
Copy link
Collaborator

Thanks @bobby-brennan but in this case I think having the deployed APIs also visible in a docs/ folder in the main branch would be confusing.

@MikeRalphson
Copy link
Collaborator

MikeRalphson commented May 8, 2018

@IvanGoncharov deploy dir now pushed to gh-pages branch. Is that ok, or does it need to live inside a v2 subdirectory?

@IvanGoncharov
Copy link
Member Author

IvanGoncharov commented May 8, 2018

@MikeRalphson Without v2 it would be a breaking change. Plus versioning allows you to switch JSON format in the future, e.g. provide only OAS3 urls.

@MikeRalphson
Copy link
Collaborator

@IvanGoncharov I wasn't querying the need for /v2/ in the current paths, I was trying to ask which files/directories in the current deploy directory / root of gh-pages need to be under v2?

@IvanGoncharov
Copy link
Member Author

Same as S3 all content of deploy dir:
image

image

@MikeRalphson
Copy link
Collaborator

Directory structure of gh-pages branch should be OK now.

@rbren
Copy link
Contributor

rbren commented May 8, 2018

FYI - I think you'll need a proxy like CloudFlare or AWS CloudFront to maintain support for HTTPS

relevant issue

@MikeRalphson
Copy link
Collaborator

@bbrennan isn't that exactly the issue addressed by the blog posting Ivan linked to initially (https://blog.github.com/2018-05-01-github-pages-custom-domains-https/)? One person who needed www. support as well should not block us.

@rbren
Copy link
Contributor

rbren commented May 9, 2018 via email

@IvanGoncharov
Copy link
Member Author

Migration completed a few weeks ago ⏳
Everything is working 👍

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

No branches or pull requests

3 participants