The portal is a community resource, and reports from readers help us keep it clear and useful. You can suggest a correction even if you do not work with GitHub regularly.
Report an issue¶
Use the Water Content Portal issue tracker to report a typo, broken link, display problem, confusing navigation, or other issue with the portal itself.
When you open an issue, include:
The page address. Copy the URL of the page where you noticed the issue.
What you found. Describe the problem and, for a broken link, include the link destination if you can.
What you expected. Explain what should happen or what wording or behavior would be clearer.
How to see it. If the issue depends on a particular screen size, browser, or sequence of steps, include those details. A screenshot can help with visual problems.
Use a short, specific title, such as “Broken link on the courseware page.” Before opening an issue, check the existing issues to see whether someone has already reported the same problem. Add a comment to an existing issue if it matches.
Make a change yourself¶
If you are comfortable editing the project, you can propose a correction as a pull request instead. The portal is built with MyST Markdown. For changes to the site itself, edit the relevant files in the Water Content Portal repository and check that the change builds as expected. The local build guide explains how to preview your work.
If the issue is in a lesson or other resource maintained in a separate repository, make the correction in that source repository rather than editing the portal’s copy. If you are not sure where the material is maintained, open an issue and include the portal page address.
For instructions on asking us to host educational materials that are not yet in the portal, see Requesting to add existing content.