imagej.github.io icon indicating copy to clipboard operation
imagej.github.io copied to clipboard

Migrate the ImageJ user guide to this website

Open hinerm opened this issue 3 years ago • 5 comments

The Working with ImageJ guide page is the result of a partial import of the ImageJ user guide.

Currently it has a lot of display problems (broken syntax) and missing sections. Possible options:

  • Remove the page for now
  • Clean up the page

hinerm avatar May 19 '21 14:05 hinerm

@tferr just wanted to put this on your radar

hinerm avatar May 19 '21 14:05 hinerm

@tferr I'm wondering whether it would make sense to attempt to programmatically migrate the entire guide to the Jekyll structure of the new wiki. What do you think? I'm willing to invest substantial hours into it, if you are interested. I think we'd need to invite the community to help update it to cover newer ImageJ versions, though—I expect neither of us have the bandwidth to do it all ourselves. But having it in consistent form with the rest of the user-editable wiki might be a step in the right direction?

ctrueden avatar May 19 '21 20:05 ctrueden

@ctrueden , Wow, thanks for not dropping this. Yes! Certainly having it in the new wiki would be the way to go. I am just really sorry I cannot help. I won't be able to do much until September. But do let me know if there is some guidance i can give. @hinerm , Perhaps a note on the existing page along these lines "The guide is being modernized [link] meanwhile the old version is here [link to PDF]"?

tferr avatar May 20 '21 17:05 tferr

"The guide is being modernized [link] meanwhile the old version is here [link to PDF]"

The html version of the original user guide is available as well for linking.

Do we have usage statistics on a page level from imagej.net? I would bet that the partially migrated wiki pages have only relatively few hits (I've never seen anyone linking to them in forum posts or such), while there's still a substantial amount of links to sub-sections of the original HTML version in the mailing list archive and on the forum.

If programmatic migration to the Jekyll structure is feasible, I'm 👍 for it. And agreed that it'll require community effort to make/keep it up to date.

imagejan avatar May 20 '21 19:05 imagejan

I am going to remove the proof-of-concept migrated /guide pages for now. They aren't linked from the menu or anywhere anyway. Once we have the bandwidth for it, I'd like to programmatically migrate the entire guide at its latest version. I know this will come with a lot of requirements (e.g., the Documentation theme for Jekyll outlines a process for PDFizing portions of a Jekyll site).

ctrueden avatar May 31 '21 04:05 ctrueden