search

HopkinsIDD / flepiMoP

The Flexible Epidemic Modeling Pipeline
https://flepimop.org
GNU General Public License v3.0
9 stars 4 forks source link

Remove GitBook Deprecated/Old/Stub Pages #283

Closed TimothyWillard closed 2 days ago

TimothyWillard commented 3 months ago

I think it's time to remove outdated pages from the GitBook documentation. In particular I'm looking at:

Is there a purpose to these pages @saraloo and @jcblemai that I'm missing?

saraloo commented 3 months ago

There are some of these that possibly @alsnhll had a vision for that was never quite complete but not 100% sure (eg the numerical methods page or the code structure page).

I don't think the inference documentation was ever fully finished as we always had hopes to redo a lot of it? So that is likely why a lot of those inference pages are incomplete or out of date.

Regarding the deprecated AWS instructions - those were previous instruction pages we kept for internal purposes. It's way too detailed and specific for the purposes of this documentation, but we wanted to keep them. I haven't used AWS to actually run anything in ages though so it's up for debate whether it still is up to date anyway. It might be worth removing these from the online documentation but perhaps archiving them somewhere?

TimothyWillard commented 3 months ago

Ah, okay, perhaps some of this would be better moved to GH-284, I was unaware of some of this. I'm just going to create a PR removing these two then:

  1. https://iddynamics.gitbook.io/flepimop/deprecated-pages/block-that-dont-go-anywhere, and
  2. https://iddynamics.gitbook.io/flepimop/group-1/page-1.

And the rest of this would probably be better suited for a that discussion. Regarding the AWS instructions, I definitely see the value in that, a just in case we need to run on AWS again mobilization situation. In that case I don't think I'd put those under the "deprecated pages" category, but instead add a GitBook hint at the top of the page explaining that they aren't deprecated but also aren't maintained.

saraloo commented 3 months ago

Yeah, great idea. Definitely worth a larger discussion re organising the documentation, so the #284 is a good spot to put thoughts. Appreciate that it is complicated to get around the documentation, so any suggestions are useful.

Let's move the AWS instructions to the JHU Internal section under US specific run. Feel free to add those to your ^ PR.

Thanks for bringing this up

TimothyWillard commented 2 days ago

Closing this as addressed by GH-291.