search

SlicerDMRI / whitematteranalysis

White matter tractography clustering and more...
https://dmri.slicer.org/whitematteranalysis/
Other
69 stars 34 forks source link

Website shows deprecated documentation #142

Open jhlegarreta opened 1 year ago

jhlegarreta commented 1 year ago

The WMA website is displaying a deprecated version of the README instructions. The website is being built from the gh-pages branch, https://github.com/SlicerDMRI/whitematteranalysis/tree/gh-pages, and the HEAD of this branch points to a 2016 commit: https://github.com/SlicerDMRI/whitematteranalysis/commit/d1133e845d1d63b48b44607619236617112ab994.

The gh-pages branch should be updated to match the instructions in the master README.md file, which have been updated several times since.

I tend to read the README file, but anyone out there reading the installation instructions on the website will be reading to deprecated instructions.

Also, the information in the README, index.html and params.json files in the gh-pages branch is duplicated. Going forward, maybe it would be best to have a single version that can be rendered directly. Maybe readthedocs can be used for this.

jhlegarreta commented 1 year ago

@zhangfanmark @pieper Have just realized about this. I cannot find where the custom domain is being specified within this repository (it is not in Settings, Pages, Custom domain). I'm wondering whether the rendered page domain is being specified at some of the forks of the SlicerDMRI community folks. Thanks.

pieper commented 1 year ago

It was being served from the gh-pages branch. image

I've just switched ti to serve from master so there should be an update in a few minutes.

jhlegarreta commented 1 year ago

It was being served from the gh-pages branch.

That I had seen, but there is no "Custom domain", right?

I've just switched ti to serve from master so there should be an update in a few minutes.

Serving from gh-pages was OK, as the branch has some JS code that was applying the style. The page has no style now, no header, no footer

IMO we should keep serving from gh-pagesand in the mid-term maybe switch to something simpler, e.g readthedocs, in line with Slicer, and easier to maintain across all repositories.

pieper commented 1 year ago

If you can migrate to readthedocs and serve the content from the master branch that would be great. Or migrate the style code into the master branch so that there's only one branch to keep up to date. Serving out of date content makes no sense and trying to maintain two branches doesn't sound sustainable for this project.

jhlegarreta commented 1 year ago

This will go to my backlog until we figure out the best way to minimize maintenance, having a consistent way to serve documentation across SlicerDMRI org repositories. Thanks Steve.