[Discussion] Documentation vs wiki #358
Comments
|
I had been thinking about it for some time now, the proposed solution looks neat, lets go for it! |
|
Awesome I will submit a pull request |
chernjie
added a commit
to chernjie/git-extras
that referenced
this issue
Apr 23, 2015
see tj#358 * wiki/master: (30 commits) git merge-repo add wiki for git-guilt Update docs for revised git-changelog. add wiki for git-merge-into git scp tj#300 link to git delta git delta usage Add git-authors Updated Commands (markdown) Updated Commands (markdown) Updated Commands (markdown) Updated Commands (markdown) Updated Commands (markdown) Fix link to git feature command Added a footer. add a few keywords some remaining dashes roughly finished Updated Commands (markdown) Updated Commands (markdown) ...
chernjie
added a commit
to chernjie/git-extras
that referenced
this issue
Apr 23, 2015
|
Pull request created at #359 |
tardypad
pushed a commit
to tardypad/git-extras
that referenced
this issue
Jul 13, 2016
see tj#358 * wiki/master: (30 commits) git merge-repo add wiki for git-guilt Update docs for revised git-changelog. add wiki for git-merge-into git scp tj#300 link to git delta git delta usage Add git-authors Updated Commands (markdown) Updated Commands (markdown) Updated Commands (markdown) Updated Commands (markdown) Updated Commands (markdown) Fix link to git feature command Added a footer. add a few keywords some remaining dashes roughly finished Updated Commands (markdown) Updated Commands (markdown) ...
tardypad
pushed a commit
to tardypad/git-extras
that referenced
this issue
Jul 13, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
and others
TL;DR
Documentation should be in the same git repo as it's main project
Long version
I understand
git-extrashave recently moved the long winded contents ofReadme.mdinto Github's wiki. It is a good thing asReadme.mdhas become too long and at some point has become difficult to maintain.Having said that, I do think that the
HEADof each wiki ref should stay in sync with theHEADof each pull request. This ensures that documentations are not left out and encourage script discovery.@hemanth has been tirelessly advising pull requesters to update the wiki on every successful review. Perhaps we could be suggested that unless documentations are updated, the PR will not be merged?
Proposed solution (simple)
Since Github's wiki is also a Git repo, we can merge it into the main repo without losing history or
refheads. Effectively retiring Github wiki.What are your thoughts on this?
The text was updated successfully, but these errors were encountered: