uplift: display link to help documentation in uplift request widget (Bug 2004078)

Display a link to the uplift request wiki page as a "help" button in
the uplift request UI widget. To facilitate this, move the URL to
a common location in `const.py` where it can be re-used.

Pull request: #743

Author: cgsheeh

src/lando/api/legacy/email.py

@@ -4,6 +4,7 @@
 from django.core.mail import EmailMessage
 
 from lando.api.legacy.validation import REVISION_ID_RE
+from lando.utils.const import UPLIFT_DOCS_URL
 
 logger = logging.getLogger(__name__)
 
@@ -49,28 +50,28 @@ def make_failure_email(
     return msg
 
 
-UPLIFT_FAILURE_EMAIL_TEMPLATE = """
-Your uplift request for {repo_name} did not complete successfully.
+UPLIFT_FAILURE_EMAIL_TEMPLATE = f"""
+Your uplift request for {{repo_name}} did not complete successfully.
 
-See here for details and merge conflicts: {job_url}
+See here for details and merge conflicts: {{job_url}}
 
 Reason:
-{reason}
+{{reason}}
 
 Review the job details linked above for more information, including
 details of any merge conflicts that were encountered.
 
 If your uplift failed due to merge conflicts, this means your patch
 cannot be uplifted without manually resolving the merge conflicts and
-re-submitting. Please pull the latest changes for {repo_name}, resolve
+re-submitting. Please pull the latest changes for {{repo_name}}, resolve
 the conflicts locally, and submit a new uplift request using `moz-phab
 uplift` once the conflicts are cleared.
 
 Once you have created a new uplift Phabricator revision, you can use the
 "Link Existing Assessment" button to link your new uplift revision to the
 uplift assessment form you previously submitted.
 
-See https://wiki.mozilla.org/index.php?title=Release_Management/Requesting_an_Uplift
+See {UPLIFT_DOCS_URL}
 for step-by-step instructions.
 """.strip()
 

src/lando/api/tests/test_uplift_email.py

@@ -2,8 +2,9 @@
     make_uplift_failure_email,
     make_uplift_success_email,
 )
+from lando.utils.const import UPLIFT_DOCS_URL
 
-FAILURE_EXPECTED_BODY = """
+FAILURE_EXPECTED_BODY = f"""
 Your uplift request for firefox-beta did not complete successfully.
 
 See here for details and merge conflicts: https://lando/jobs/1
@@ -24,7 +25,7 @@
 "Link Existing Assessment" button to link your new uplift revision to the
 uplift assessment form you previously submitted.
 
-See https://wiki.mozilla.org/index.php?title=Release_Management/Requesting_an_Uplift
+See {UPLIFT_DOCS_URL}
 for step-by-step instructions.
 """.strip()
 

src/lando/ui/jinja2/stack/partials/uplift-form.html

@@ -35,7 +35,7 @@
                     <a class="button"
                        target="_blank"
                        type="button"
-                       href="https://wiki.mozilla.org/index.php?title=Release_Management/Requesting_an_Uplift">
+                       href="{{ uplift.docs_url }}">
                         <span class="icon">
                             <i class="fa fa-question-circle"></i>
                         </span>

src/lando/ui/jinja2/stack/partials/uplift-section.html

@@ -158,6 +158,16 @@ <h1>Uplifts</h1>
                                 <p class="is-size-7 has-text-grey">
                                     <time data-timestamp="{{ uplift_request.created_at }}"></time>, by {{ uplift_request.requested_by.email }}.
                                 </p>
+                                <div class="mt-1">
+                                    <a class="button is-small is-light"
+                                       target="_blank"
+                                       href="{{ uplift.docs_url }}">
+                                        <span class="icon is-small">
+                                            <i class="fa fa-question-circle"></i>
+                                        </span>
+                                        <span>Help</span>
+                                    </a>
+                                </div>
                             </div>
                         </div>
                     </div>

src/lando/ui/uplift/context.py

@@ -15,6 +15,7 @@
     UpliftAssessmentForm,
     UpliftRequestForm,
 )
+from lando.utils.const import UPLIFT_DOCS_URL
 
 
 @dataclass(frozen=True, slots=True)
@@ -28,6 +29,7 @@ class UpliftContext:
     assessment_link_form: LinkUpliftAssessmentForm | None
     can_create_uplift_submission: bool
     revision_id: int
+    docs_url: str
 
     @classmethod
     def build(
@@ -69,6 +71,7 @@ def build(
             assessment_link_form=assessment_link_form,
             can_create_uplift_submission=cls.can_create_submission(request),
             revision_id=revision_id,
+            docs_url=UPLIFT_DOCS_URL,
         )
 
     @staticmethod

src/lando/utils/const.py

@@ -14,3 +14,8 @@
     "(?P<userinfo>[-A-Za-z0-9:._~%!$&'*()*+;=]*:[-A-Za-z0-9:._~%!$&'*()*+;=]*@)",
     flags=re.MULTILINE,
 )
+
+# Uplift documentation URL.
+UPLIFT_DOCS_URL = (
+    "https://wiki.mozilla.org/index.php?title=Release_Management/Requesting_an_Uplift"
+)