Update User Guide with deploying to GitHub User pages #3510
Conversation
|
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed. If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
| If you are deploying to a GitHub user page instead of a project page you'll need to make two | ||
| additional modifications: | ||
|
|
||
| 1. First, change your repository's source branch to be any branch other than **master**. |
There was a problem hiding this comment.
Is this the only way to accomplish this? Seems kind of hacky but I don't know enough about GitHub Pages.
There was a problem hiding this comment.
Taken from GitHub settings for my particular user page: "User pages must be built from the master branch."
Unfortunately, I don't see any other way around this. At least until GitHub decides to support hosting user pages out of other branches.
There was a problem hiding this comment.
Great, that's all the confirmation I needed. 😄
| "homepage": "https://myusername.github.io/my-app", | ||
| ```json | ||
| "homepage": "https://myusername.github.io, // for a GitHub user page | ||
| "homepage": "https://myusername.github.io/my-app", // for a GitHub project page |
There was a problem hiding this comment.
Can we split this into two separate examples? Just a separate json snippet with text preceding it saying like "or for a GitHub project page ..."
There was a problem hiding this comment.
Sure, I'll tweak it.
| or for a GitHub user page: | ||
|
|
||
| ```json | ||
| "homepage": "https://myusername.github.io, |
|
Cheers, thanks! |
Added details to the User Guide specifying how to deploy to a GitHub user page, instead of a project page.
Tested here: https://github.com/aaronlna/aaronlna.github.io
Issue: #3456