Skip to content

Merge wiki into main repository#359

Merged
hemanth merged 32 commits intotj:masterfrom
chernjie:docs
Apr 27, 2015
Merged

Merge wiki into main repository#359
hemanth merged 32 commits intotj:masterfrom
chernjie:docs

Conversation

@chernjie
Copy link
Copy Markdown
Contributor

Closes #358

TL;DR

Documentation should be in the same git repo as it's main project

Long version

I understand git-extras have recently moved the long winded contents of Readme.md into Github's wiki. It is a good thing as Readme.md has become too long and at some point has become difficult to maintain.

Having said that, I do think that the HEAD of each wiki ref should stay in sync with the HEAD of 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.

Follow up task

  • update wiki

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)
  ...
@hemanth
Copy link
Copy Markdown
Collaborator

hemanth commented Apr 24, 2015

👍

Shall I merge after the wiki is updated?

@hemanth
Copy link
Copy Markdown
Collaborator

hemanth commented Apr 26, 2015

Ping @chernjie

@chernjie
Copy link
Copy Markdown
Contributor Author

Oh sorry, I missed your message.

By "updating wiki", I mean to delete all the contents there, linking back to main repository. Are you okay with that?

For release, yes you can merge this. We can always update the wiki later.

@hemanth
Copy link
Copy Markdown
Collaborator

hemanth commented Apr 27, 2015

Just like back to the readme in wiki would be good, as people might go to wiki to read the docs, I'll merge this for now, Thank you!

hemanth added a commit that referenced this pull request Apr 27, 2015
Merge wiki into main repository
@hemanth hemanth merged commit 6e4152d into tj:master Apr 27, 2015
@hemanth
Copy link
Copy Markdown
Collaborator

hemanth commented Apr 27, 2015

Just like back to the readme in wiki would be good, as people might go to wiki to read the docs, I'll merge this for now, Thank you!

@chernjie chernjie deleted the docs branch April 27, 2015 05:49
@chernjie
Copy link
Copy Markdown
Contributor Author

Wiki updated with the relevant links :)

@hemanth
Copy link
Copy Markdown
Collaborator

hemanth commented Apr 27, 2015

👍

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Discussion] Documentation vs wiki

9 participants