wiki edit history lost

[lukeje]

The git history has not been moved over from the old wiki, and now shows all the documentation as being written by @halirutan. This could relatively easily be fixed (e.g. by merging the wiki repository explicitly rather than copying files manually) so that proper credit is given to the people who wrote the documentation.

[Barisevrenugur]

(moved to #9) on request

[lukeje]

@Barisevrenugur I think your point is a different issue, and shouldn't be conflated with this one. Please create a new issue rather than taking this one off topic.

[Barisevrenugur]

@lukeje perhaps one other way was to simply edit the title, but OK i simply deleted it and added the new issue tag

[halirutan]

I don't know how to get the history of the wiki into this repository. If you think this step is necessary, please feel free to provide a PR. Alternatively, we could explicitly mention here

https://hmri-group.github.io/hMRI-toolbox-docs/docs/#about-the-documentation

that the documentation of the toolbox is a joint effort by the whole hMRI Toolbox team.

[lukeje]

The easiest way would be to start from https://github.com/hMRI-group/hMRI-toolbox.wiki.git and then add the website stuff. This should be possible using git cherry-pick and the --allow-unrelated-histories argument. If you've never done this before, then I'd be happy to help, as I used this approach to combine a couple of related repositories of mine recently.

[halirutan]

As I said, feel free to make a PR with the fix.

[lukeje]

Perhaps we can discuss offline tomorrow; I think this is very important and worth doing, but it will take me a while to find the time.

[lukeje]

So this seems to work (barring that the decision to add newlines everywhere has caused the diffs to look awful):

# get remotes
git clone --origin wiki https://github.com/hMRI-group/hMRI-toolbox.wiki.git hMRI-toolbox.wiki
cd hMRI-toolbox.wiki
git remote add docs https://github.com/hMRI-group/hMRI-toolbox-docs.git
git fetch docs main

# wiki branch with folders matching docs repo
git switch -c merge-with-docs wiki/master
mkdir docs
mkdir docs/{assets,development,docs}
git rm _Sidebar.md

# prepare "assets"
mkdir docs/assets/images
git mv images docs/assets/images/docs

# prepare "development"
git mv Contribute.md docs/development/contribute.md
git mv Releases.md docs/development/releases.md
git mv DevelopmentGuidelines.md docs/development/unit_tests.md

# prepare "docs"
git mv BIDS.md QUIQI.md docs/docs/
for s in *.md; do 
    git mv $s "${s,}" # make filenames start with lowercase
done
git mv *.md docs/docs/

# commit renamed files to repo
git commit -m"Rename files in preparation for merge"

# prepare squashed docs repo
git switch -c squashed docs/main
git reset $(git commit-tree HEAD^{tree} -m "Squashed repo")

# generate patch with differences between docs and wiki repos
git diff merge-with-docs --binary > ../wiki.patch

# apply patch
git checkout merge-with-docs
git apply ../wiki.patch
git add -A
git commit -m"Merge @halirutan's changes to convert wiki to mkdocs"