Port HowTo to main NIU website#294
Conversation
|
Once merged, I will redirect the howto domain to this new page |
|
If we care about preserving commit history of HowTo, we could consider using git-filter-repo to rewrite HowTo's history (in a throw-away "filtered" clone) so the paths match where we will put the files in the website repo. Roughly we are mapping:
We can then add the filtered clone as a remote to the website repo, and merge it into the website repo |
|
Do we care though? I figured for a docs site, this was overkill. It's always taken a very long time when we've done in the past for BrainGlobe. |
|
Im not sure that helps greatly. We want people to be able to go to one place and search. I think having multiple sites is a convenience for developers, but doesn't help users much. We lose out a lot by not having all our resources in one place as much as possible. |
|
Thanks for taking the initiative @adamltyson. PRs neuroinformatics-unit/HowTo#80 and neuroinformatics-unit/HowTo#81 are very close to merrging, and I could do that tomorrow while also fixing the broken links. Could we not hold off merging this one until Friday? I wouldn't want to go through re-opening neuroinformatics-unit/HowTo#80 here, I'd just merge it on HowTo and then copy the whole updated file to this PR. |
|
Yeah no rush! |
|
I've merged 3 PRs on HowTo: 84 (fixing linkcheck errors), 80 (a typo fix) and 81 (the updated SLEAP HPC guide). Should I also port these changes onto this branch? |
|
yeah if you don't mind. you may get a merge error with the linkcheck fixes (i also fixed them here), but feel free to just keep your changes |
Port linkcheck config from HowTo PR 84: ignore all gin.g-node.org (slow/times out) and cambridgeneurotech.com (HTTP 415), and drop the now-redundant GIN wiki anchor-ignore entries. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Port content linkcheck fixes from HowTo PR 84: replace pubmed and elifesciences URLs with stable DOI links in the electrophysiology resources and example pipeline pages. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Port HowTo PR 80: correct a typo in the GIN repositories guide. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Port HowTo PR 81: rewrite the SLEAP HPC module guide for the new PyTorch-based SLEAP (sleap train/track, YAML configs), with a Legacy (TensorFlow) modules section for older modules. Preserves the website's _static/howto include paths. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
I reasoned that this was a suitable task for @claude. I ported the three recently merged HowTo PRs (84, 80, 81) onto this branch. Since the files live in different locations here, these were applied by 'hand' rather than cherry-picked. Where the two repos had diverging linkcheck fixes, I kept HowTo PR 84's approach as agreed. Changes
NotesThis branch had already independently picked up most of PR 84's content fixes, so those weren't re-touched. |
niksirbi
left a comment
There was a problem hiding this comment.
From my POV this can be merged.
However:
- we should definitely open an issue about refactoring the abundance of guides and resources under 'More' into a more logical organisation.
- what's our plan about the open HowTo issues, should we transfer those as well after this PR is merged?
- The currently open 2 HowTo PRs (one by me and one by @sfmig) would have to be re-opened against this repo). Presumably not too much pain since they're both still in draft?

This PR closes #290
Working on this made me more convinced that this PR is necessary. The HowTo guide has languished somewhat. Lots of links don't work, partially because we don't look at it much, nevermind everyone else.
So far I've just very naively copied the content from HowTo to here. Not sure if we want to anything more, such as add a card on the main site or something to promote it more.
N.B. I need to do a final check to make sure all the content makes sense in its new place.Once merged, we should do something about neuroinformatics-unit/HowTo#78, neuroinformatics-unit/HowTo#80, neuroinformatics-unit/HowTo#81, neuroinformatics-unit/HowTo#82.
I suggest we just merge this as is, and work on improving the guide and it's accessibility separately, unless anyone has any ideas for things we should do now?