Gh pages documentation tweak

[nastiatikk]

Status: Ready for Review Reviewers: @jeffkamo @ry5n @avelinet @tedtate

Changes

• Documentation updated with TODO instructions when you directly committed to gh-pages branch

  Todos:

• [x] Designer +1 @ry5n
• [x] Designer +1 @jeffkamo

[ry5n]

+1

[tedtate]

I'm a little confused by these instructions. What do we mean by remove github-pages branch?

[nastiatikk]

@tedtate Ops, will it be clearer if it's said delete?

[jeffkamo]

Might help to clarify by saying you must delete the gh-pages branch from the Github repo (or even more specifically, from remote origin)

[tedtate]

Okay, but if you already have the commits which broke the branch locally, you are going to end up right in the same place...

[nastiatikk]

@tedtate I think I need to clarify the instructions more. Generally if you pushed a commit you need to revert this commit, then you need to push this revert, then you need to delete a branch and then you need to run git push origin gh-pages what will also publish the branch. If you don't remove the branch and run git push origin gh-pages it will run with errors.

[jeffkamo]

@tedtate @nastiatikk not quite. This documentation is not to clarify how to fix a broken gh-pages branch. Rather, it explains how to fix the broken git subtree split --branch gh-pages --prefix tests/ command, which breaks when you commit directly to gh-pages.

[nastiatikk]

Oh right. With only exception it fixes git push origin gh-pages command

[jeffkamo]

+1