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

Comments

Projects
None yet
3 participants
@IvanGoncharov
Member

IvanGoncharov commented May 2, 2018

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

This comment has been minimized.

Show comment
Hide comment
@IvanGoncharov

IvanGoncharov May 2, 2018

Member

@MikeRalphson What do you think?

Member

IvanGoncharov commented May 2, 2018

@MikeRalphson What do you think?

@MikeRalphson

This comment has been minimized.

Show comment
Hide comment
@MikeRalphson

MikeRalphson May 2, 2018

Collaborator

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

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.

@bobby-brennan

This comment has been minimized.

Show comment
Hide comment
@bobby-brennan

bobby-brennan May 4, 2018

Contributor

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

Contributor

bobby-brennan 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

This comment has been minimized.

Show comment
Hide comment
@MikeRalphson

MikeRalphson May 8, 2018

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.

Collaborator

MikeRalphson commented May 8, 2018

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

This comment has been minimized.

Show comment
Hide comment
@MikeRalphson

MikeRalphson May 8, 2018

Collaborator

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

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

This comment has been minimized.

Show comment
Hide comment
@IvanGoncharov

IvanGoncharov May 8, 2018

Member

@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.

Member

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

This comment has been minimized.

Show comment
Hide comment
@MikeRalphson

MikeRalphson May 8, 2018

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?

Collaborator

MikeRalphson commented May 8, 2018

@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

This comment has been minimized.

Show comment
Hide comment
@IvanGoncharov

IvanGoncharov May 8, 2018

Member

Same as S3 all content of deploy dir:
image

image

Member

IvanGoncharov commented May 8, 2018

Same as S3 all content of deploy dir:
image

image

@MikeRalphson

This comment has been minimized.

Show comment
Hide comment
@MikeRalphson

MikeRalphson May 8, 2018

Collaborator

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

Collaborator

MikeRalphson commented May 8, 2018

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

@bobby-brennan

This comment has been minimized.

Show comment
Hide comment
@bobby-brennan

bobby-brennan May 8, 2018

Contributor

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

relevant issue

Contributor

bobby-brennan 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

This comment has been minimized.

Show comment
Hide comment
@MikeRalphson

MikeRalphson May 9, 2018

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.

Collaborator

MikeRalphson commented May 9, 2018

@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.

@bobby-brennan

This comment has been minimized.

Show comment
Hide comment
@bobby-brennan

bobby-brennan May 9, 2018

Contributor
Contributor

bobby-brennan commented May 9, 2018

@IvanGoncharov

This comment has been minimized.

Show comment
Hide comment
@IvanGoncharov

IvanGoncharov May 29, 2018

Member

Migration completed a few weeks ago
Everything is working 👍

Member

IvanGoncharov commented May 29, 2018

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