How to get help?

[sunt05]

A common issue when using the UMEP-family softwares (UMEP, SUEWS, SuPy, etc.) is:
How to get help?

Here, we answer this general question in the following sub-topics:

• How to get a GH account?

• How to raise issues in your manuals on GitHub?

• How to set up a discussion?

• How to use the online commentary systems embedded at your documentation site?

[sunt05]

How to get a GH account?

Please follow this guide (from wikiHow).

[sunt05]

How to raise issues in your manuals on GitHub?

At the top of each manual page, there is a banner like the following:

please click the link in the red rectangle, which will direct you the correct software repo and create a new issue specific to the page you are redirected from.

[sunt05]

How to set up a discussion on GH?

First, you need a GH account; then it's pretty straightforward:
just come here and click the green button shown in the pic below:

Let us hear your voice 🔉

[sunt05]

How to use the online commentary systems embedded at your documentation site?

At some UMEP-family documentation sites, you may notice two commentary systems:

1. hypothes.is; and
2. utteranc.es.
   

hypothes.is

hypothes.is is a popular online annotation system and allows users to annotate webpages with public/private notes.
An ultrafast-start can be found here.

utteranc.es

utteranc.es is a GH-issues-based commentary system that makes it easier to comment on a specific GH-based docs page.
So if you have questions and find issues of a specific docs page, please use that to interact with the community (for sure, you need a GH account).