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

Make a /docs a Git subtree #3647

Closed
bep opened this Issue Jun 26, 2017 · 3 comments

Comments

Projects
None yet
2 participants
@bep
Member

bep commented Jun 26, 2017

While the splitting of docs => hugoDocs was a good idea, and we should continue with that, the submodule approach has some major flaws:

  1. It's not possible to create an "atomic PR" with both code and documentation changes.
  2. Old PRs that does the above is no longer easily mergeable.
  3. This change made the release process more complex than needed.

Maybe Git subtrees?

https://developer.atlassian.com/blog/2015/05/the-power-of-git-subtree/

Help/suggestions welcome. I think we got to fix this sooner than later.

/cc @digitalcraftsman @spf13 @moorereason @anthonyfok

@bep bep added this to the v0.25 milestone Jun 26, 2017

@bep bep self-assigned this Jun 26, 2017

@bep

This comment has been minimized.

Show comment
Hide comment
@bep

bep Jun 26, 2017

Member

This article describes it pretty well:

https://medium.com/@v/git-subtrees-a-tutorial-6ff568381844

Member

bep commented Jun 26, 2017

This article describes it pretty well:

https://medium.com/@v/git-subtrees-a-tutorial-6ff568381844

@bep bep changed the title from Find alternative to submodule for /docs to Make a /docs a Git subtree Jun 26, 2017

@bep

This comment has been minimized.

Show comment
Hide comment
@bep

bep Jun 26, 2017

Member

Notes:

git remote add docs git@github.com:gohugoio/hugoDocs.git 
git subtree add --prefix=docs/ docs master --squash

Pulling changes should be:

git subtree pull --prefix=docs/ docs master --squash

@digitalcraftsman we should mostly do changes in hugoDocs, but I guess we can synch both ways if needed (use case: PRs with docs changes). We should live with this for a while to test it out and update contrib. guide.

Member

bep commented Jun 26, 2017

Notes:

git remote add docs git@github.com:gohugoio/hugoDocs.git 
git subtree add --prefix=docs/ docs master --squash

Pulling changes should be:

git subtree pull --prefix=docs/ docs master --squash

@digitalcraftsman we should mostly do changes in hugoDocs, but I guess we can synch both ways if needed (use case: PRs with docs changes). We should live with this for a while to test it out and update contrib. guide.

bep added a commit that referenced this issue Jun 26, 2017

Remove the docs submodule
Will be replaced by a Git subtree.

See #3647

@bep bep closed this Jun 26, 2017

@digitalcraftsman

This comment has been minimized.

Show comment
Hide comment
@digitalcraftsman

digitalcraftsman Jun 26, 2017

Member

@bep re the use of the master branch: please have a look at gohugoio/hugoDocs#19 (comment).

Member

digitalcraftsman commented Jun 26, 2017

@bep re the use of the master branch: please have a look at gohugoio/hugoDocs#19 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment