Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

software and containers page updates #1110

Open
vortexing opened this issue Jan 10, 2025 · 4 comments
Open

software and containers page updates #1110

vortexing opened this issue Jan 10, 2025 · 4 comments
Assignees
Labels
refresh content Refreshing existing content to reflect the current reality
Milestone

Comments

@vortexing
Copy link
Collaborator

URL of existing content (a rendered, sciwiki.fredhutch.org link)

https://sciwiki.fredhutch.org/scicomputing/compute_environments/

Specific information requests or concerns, or specific region on page of content to refresh.

@ GitHub username of the listed primary reviewer of the page if known

@vortexing vortexing added the refresh content Refreshing existing content to reflect the current reality label Jan 10, 2025
@vortexing vortexing added this to the Feb PR review milestone Jan 28, 2025
@tefirman
Copy link
Contributor

@vortexing @sitapriyamoorthi -- Thoughts on these proposed updates?

SciWiki Docker Content Refresh

Current State

Core Content:

  • “Computing Environments and Containers” (SciComp)
    • Comprehensive article about environments at FH, potentially too long…
    • Environment Modules, Docker Containers, Virtual Environments with Python/R
  • “Using Apptainer Containers” (SciComp)
    • Instructions specific to Apptainer, important for cluster usage
  • “Building Software Containers” (HDC)
    • Step by step building instructions
  • “Using Docker at Fred Hutch”
    • Limited info, pretty much a shell
  • “Why is your computing environment important?”
    • Summary article from Ted

Mentioned in:

  • “Workflow Background”
    • Nextflow overview from Sam Minot
  • “Cromwell Workflow Manager and WDL Workflows”
    • WDL overview from Amy
  • “Running Workflows on Gizmo”
    • Nitty-gritty of running Nextflow, includes super helpful example config
  • “Using AWS Batch”
  • “Nextflow - an Emerging Service for Workflow Management”
  • “PROOF Troubleshooting”

Proposed State

Priority:

  • Split “Computing Environments and Containers” into three separate articles
    • Environment Modules
    • Docker Container Background
    • Virtual Environments with Python/R
  • Delete/absorb “Using Docker at Fred Hutch” into "Building Software Containers"
    • Add more command line details and point to WILDS Docker Library
  • Leave Ted’s article as-is, good overview of why each one is important
  • Leave “Using Apptainer” article as-is, important distinction
  • Update links wherever Docker is mentioned

Optional:

  • Consolidate “Workflow Background” and “Nextflow” articles into one?
  • Update Cromwell/WDL article to include miniWDL, Sprocket, example config

Notes

Search seems to be indexing deleted pages in “datademos” and “_datademos”, produces 404 errors, which will probably deter readers…

@vortexing
Copy link
Collaborator Author

FYI @tefirman I don't believe search works in teh preview site b/c it renders against what's in main. So that's a red herring.

@vortexing vortexing changed the title page update software and containers page updates Feb 17, 2025
@vortexing
Copy link
Collaborator Author

Seems like a big chunk of work that we should do together in March instead of with this massive reorg.

@tefirman
Copy link
Contributor

Seems like a big chunk of work that we should do together in March instead of with this massive reorg.

Totally agree, smarter to finish the reorg and we can address this after.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refresh content Refreshing existing content to reflect the current reality
Projects
None yet
Development

No branches or pull requests

2 participants