Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Guide for Contributing to the CUAHSI Water Content Portal

The CUAHSI Water Content Portal is a community-driven resource. We rely on contributions from water science researchers and educators to keep our learning materials accurate and comprehensive.

Why Contribute?

Contributing helps make useful water science learning materials easier to discover, access, reuse, and be recognized. This portal is designed to support open, and FAIR (Findable, Accessible, Interoperable and Reusable) use, and resources can be archived in HydroShare to increase its visibility and so that learners and other researchers can cite a specific page or collection.

Authors may also request an Authorship Impact Report to summarize engagement with the pages they contributed; this information may help communicate the reach of their work in a CV, resume, or other professional materials.

By sharing new materials, correcting issues, and keeping resources current, contributors help strengthen an accurate, growing collection for the water science community. Learn more about making your content citable and keeping it up to date.

Ways to Contribute

There are three primary ways you can help improve this resource:

  1. Suggest a platform edit: Report a typo, broken link, navigation issue, or other problem with the portal. See Suggesting a platform edit.

  2. Add existing content: Ask us to include educational water science materials you already maintain. See Requesting to add existing content.

  3. Keep contributed content up to date: Update the material in its source repository, then let us know so we can update the portal. See Keeping your portal content up to date.

Content Management Workflow

The portal aggregates educational resources from contributors’ external repositories using Git submodules. The source material stays in its original repository, and the portal points to a specific version of that material. When a source repository changes, the portal needs to be updated to point to the newer version.

The diagram below shows this workflow using Chapter 1 of the Hydroinformatics book as an example:

submodules-workflow

If you maintain an existing resource, start with Requesting to add existing content. If your resource is already in the portal, follow Keeping your portal content up to date when you publish changes.