Add Policies FAQ to links and restructure links to make them more obvious #23689

KevinMind · 2025-07-14T13:55:35Z

Description

Refactor documentation links and update agreement form layout

Replaced hardcoded URLs in the docs view with helper functions for better maintainability.
Updated the agreement form in the template to use labels for inputs, improving accessibility.
Adjusted the test for agreement form errors to match the new HTML structure.
Added a redirect test for the policies documentation page.

Context

We need to add another link to an already confusing html structure and we mention the "exact" same words in the paragraph above explaining the context. We can just ad the links there instead of confusingly adding them (and then mulitiple sibling links) inside the html form.

Testing

with a fresh developer account, open the agreement form
the checkbox items should be clickable links to open the linked docs in a new tab
there should be a new FAQ link in the form description that opens the new FAQ page on extensionworkshop
all links should have a utm_referrer=amo parameter.

Screen.Recording.2025-07-24.at.01.04.07.mov

Checklist

Add #ISSUENUM at the top of your PR to an existing open issue in the mozilla/addons repository.
Successfully verified the change locally.
The change is covered by automated tests, or otherwise indicated why doing so is unnecessary/impossible.
Add before and after screenshots (Only for changes that impact the UI).
Add or update relevant docs reflecting the changes made.

eviljeff

code review r+wc

I'll check it out for a test once Frantz has okayed the copy, etc.

src/olympia/devhub/views.py

src/olympia/devhub/templates/devhub/includes/agreement.html

…ge in template - Replaced hardcoded URLs in the `docs` view with helper functions for better maintainability. - Updated the agreement message in the `agreement.html` template to include a link to the FAQ and improved wording. - Adjusted test case to reflect the change in the URL structure for the policies documentation. Refactor URL generation in `docs` view and enhance test assertions - Introduced a helper function `get_url` to streamline URL construction in the `docs` view. - Updated test cases to assert the presence of the `utm_referrer=amo` query parameter for 301 redirects. - Improved readability of the test case by unpacking the URL and status code directly in the loop. Update src/olympia/devhub/templates/devhub/includes/agreement.html Co-authored-by: Copilot <[email protected]> TMP: better name for argument

…erenced links to the docs link test

eviljeff

I think this is working as expected, from reading the back and forth - the testing instructions and video relate to an earlier iteration.

KevinMind · 2025-07-24T12:28:03Z

The video I updated last night and the solution we ended up going with is having the FAQ link in the form description and keeping all of the other links the same.

I'll double check the test instructions to make sure they match.

…ious (#23689) * Refactor documentation URLs in `docs` view and update agreement message in template - Replaced hardcoded URLs in the `docs` view with helper functions for better maintainability. - Updated the agreement message in the `agreement.html` template to include a link to the FAQ and improved wording. - Adjusted test case to reflect the change in the URL structure for the policies documentation. Refactor URL generation in `docs` view and enhance test assertions - Introduced a helper function `get_url` to streamline URL construction in the `docs` view. - Updated test cases to assert the presence of the `utm_referrer=amo` query parameter for 301 redirects. - Improved readability of the test case by unpacking the URL and status code directly in the loop. Update src/olympia/devhub/templates/devhub/includes/agreement.html Co-authored-by: Copilot <[email protected]> TMP: better name for argument * TMP: fix broken link rendering false positives by adding actually referenced links to the docs link test * TMP: fix broken test

KevinMind force-pushed the kevinmind/addons/15681 branch from 8934c3b to 4a67ec2 Compare July 14, 2025 14:55