Accessible links #11369

jsoref · 2025-10-16T12:47:44Z

I'm sorry, the branch selection text above doesn't include accessible links explaining to a mortal how to determine if something should be a hotfix. As such, I'm targeting develop, however I can easily rebase and change the destination branch.

Purpose

Do not use `(click) here` links

For more information, see:

Changes

Fixes a couple of typos
Fixes a couple of branding errors

QA Notes

Please make verification statements inspired by your code and what your code touches.

Verify
Verify

What are the areas of risk?

Any concerns/considerations/questions that development raised?

Documentation

Side Effects

Ticket

Signed-off-by: Josh Soref <[email protected]>

addons/bitbucket/models.py

jsoref · 2025-10-16T12:49:05Z

addons/gitlab/api.py

            raise HTTPError(http_status.HTTP_403_FORBIDDEN, data={
-                'message_long': 'Your Gitlab token is deleted or invalid you may disconnect your Gitlab account and '
-                                'reconnect with a valid token <a href="/settings/addons/">here</a>.'
+                'message_long': 'Your GitLab token is deleted or invalid you may <a href="/settings/addons/">disconnect '


branding fix: https://about.gitlab.com/company/

addons/gitlab/models.py

jsoref · 2025-10-16T12:50:51Z

website/templates/emails/pending_embargo_termination_admin.html.mako

-    To approve this requst: <a href="${approval_link}">Click here</a>.<br>
-    To cancel this request: <a href="${disapproval_link}">Click here</a>
+    You can <a href="${approval_link}">approve this request</a>.<br>
+    Or you can <a href="${disapproval_link}">cancel this request</a>.


Includes typo fix

Signed-off-by: Josh Soref <[email protected]>

…ch field Signed-off-by: Josh Soref <[email protected]>

Signed-off-by: Josh Soref <[email protected]>

…n form Signed-off-by: Josh Soref <[email protected]>

jsoref · 2025-10-16T18:13:01Z

website/templates/emails/reviews_submission_status.html.mako

                                <li>Upload supplemental, materials, data, and code to the OSF project associated with your ${document_type}.
                                    <a href="https://help.osf.io/article/177-upload-a-preprint" target="_blank">Learn how</a></li>
-                                <li>Preregister your next study. <a href="https://help.osf.io/345-create-registrations">Read more</a></li>
+                                <li>Preregister your next study. See <a href="https://help.osf.io/345-create-registrations">Create a Registration</a></li>


Read more (345-create-registrations) is 404 #11366

addons/gitlab/models.py

futa-ikeda

Thank you so much for going through and updating these! I've left a couple suggestions for potential readability improvements, and if you could remove the unneeded aria-label in gitlab/models.py, that would be much appreciated!

website/templates/emails/access_request_submitted.html.mako

website/templates/emails/node_request_institutional_access_request.html.mako

website/templates/emails/reviews_submission_status.html.mako

futa-ikeda

Apologies for missing this the first time around. Just a couple of minor updates I noticed, but otherwise, should be all good!

website/templates/emails/reviews_submission_status.html.mako

website/templates/emails/node_request_institutional_access_request.html.mako

Signed-off-by: Josh Soref <[email protected]>

jsoref · 2025-10-21T18:21:40Z

website/templates/emails/access_request_submitted.html.mako

    <a href="${requester.absolute_url}">${requester.fullname}</a> has requested access to your ${node.project_or_component} "<a href="${node.absolute_url}">${node.title}</a>."<br>
    <br>
-    To review the request, click <a href="${contributors_url}">here</a> to allow or deny access and configure permissions.<br>
+    <a href="${contributors_url}">Review the request</a> to allow or deny access and configure permissions.<br>


Here's one instance of dropping To

jsoref · 2025-10-21T18:22:10Z

website/templates/emails/node_request_institutional_access_request.html.mako

        % endif
        <p>
-            To review the request, click <a href="${node.absolute_url}contributors/">here</a> to allow or deny access and configure permissions.
+            <a href="${node.absolute_url}contributors/">Review the request</a> to allow or deny access and configure permissions.


Here's the other instance of dropping To

website/templates/emails/reviews_submission_status.html.mako

jsoref · 2025-10-21T18:24:03Z

website/templates/emails/reviews_submission_status.html.mako

                                <li>Upload supplemental, materials, data, and code to the OSF project associated with your ${document_type}.
-                                    <a href="https://help.osf.io/article/177-upload-a-preprint" target="_blank">Learn how</a></li>
-                                <li>Preregister your next study. <a href="https://help.osf.io/345-create-registrations">Read more</a></li>
+                                    Learn how to <a href="https://help.osf.io/article/177-upload-a-preprint" target="_blank">upload a preprint</a>.</li>


Similarly, this Learn how also deserves a fix.

jsoref · 2025-10-21T18:24:19Z

website/templates/emails/reviews_submission_status.html.mako

-                                    <a href="https://help.osf.io/article/177-upload-a-preprint" target="_blank">Learn how</a></li>
-                                <li>Preregister your next study. <a href="https://help.osf.io/345-create-registrations">Read more</a></li>
+                                    Learn how to <a href="https://help.osf.io/article/177-upload-a-preprint" target="_blank">upload a preprint</a>.</li>
+                                <li>Preregister your next study. Learn how to <a href="https://help.osf.io/345-create-registrations">create a registration</a>.</li>


I'm adding .s because these now feel very much like sentences as opposed to random words.

futa-ikeda

Thank you so much for these updates! I'll leave an approval here, but will hold off on merging this, as I want to run this past a couple people on our end.

futa-ikeda · 2025-10-27T20:00:20Z

website/templates/emails/reviews_submission_status.html.mako

 			Your submission ${reviewable.title}, submitted to ${reviewable.provider.name},
            has not been accepted. Your registration was returned as a draft so you can make the appropriate edits for resubmission.
-			<a href=${draft_registration.absolute_url}>Click here</a> to view your draft.
+			<a href=${draft_registration.absolute_url}>View your draft</a>.
        % else:
 			Your submission <a href="${reviewable.absolute_url}">${reviewable.title}</a>, submitted to ${reviewable.provider.name}, has been accepted by the moderator.


There seems to be some areas where the $ sign has been removed for the template variables. Could you add those back in?

Are you sure? I think the $ is just being highlighted being the syntax highlighter doesn't think it's valid html (I don't think it understands .mako

Oh, yes, you're right! That makes more sense. Sorry for the confusion!

futa-ikeda · 2025-10-27T20:00:39Z

website/templates/emails/reviews_submission_status.html.mako

+                                    <li>Submit your preprint to an APA-published journal. Learn about <a href="https://help.osf.io/article/376-preprints-home-page#Submitting-to-a-Moderated-Preprint-Service-nueKG">Submitting to a Moderated Preprint Service</a>.</li>
                                % endif

                                <li>Upload supplemental, materials, data, and code to the OSF project associated with your ${document_type}.


One more dropped $ here as well

Lines that aren't pink/green aren't changed by me, so that's definitely the syntax highlighter not understanding the syntax.

Yep, sorry, definitely misread these syntax highlighting here too!

link: documentation for this endpoint

acdba2e

Signed-off-by: Josh Soref <[email protected]>

jsoref marked this pull request as draft October 16, 2025 12:48

jsoref commented Oct 16, 2025

View reviewed changes

jsoref added 8 commits October 16, 2025 08:52

link: download the contents of this repository

f6d0eec

Signed-off-by: Josh Soref <[email protected]>

link: files in this repo

2ad1114

Signed-off-by: Josh Soref <[email protected]>

link: disconnect your GitLab account and reconnect with a valid token

ba4469c

Signed-off-by: Josh Soref <[email protected]>

link: more information on locations

8c44cec

Signed-off-by: Josh Soref <[email protected]>

link: example of a full custom taxonomy and more information about ea…

1c0552c

…ch field Signed-off-by: Josh Soref <[email protected]>

link: set a password

f5a4253

Signed-off-by: Josh Soref <[email protected]>

link: questions and comments

e9036ec

Signed-off-by: Josh Soref <[email protected]>

link: blank version of the Election Research Preacceptance Competitio…

4e3eb14

…n form Signed-off-by: Josh Soref <[email protected]>

jsoref force-pushed the accessible-links branch from faafb82 to 7b055ea Compare October 16, 2025 12:53

jsoref marked this pull request as ready for review October 16, 2025 12:53

jsoref commented Oct 16, 2025

View reviewed changes

addons/gitlab/models.py Outdated Show resolved Hide resolved

futa-ikeda suggested changes Oct 21, 2025

View reviewed changes

jsoref force-pushed the accessible-links branch from fd5fae4 to 1f7e812 Compare October 21, 2025 15:34

jsoref requested a review from futa-ikeda October 21, 2025 16:12

futa-ikeda suggested changes Oct 21, 2025

View reviewed changes

website/templates/emails/reviews_submission_status.html.mako Outdated Show resolved Hide resolved

website/templates/emails/node_request_institutional_access_request.html.mako Outdated Show resolved Hide resolved

jsoref added 11 commits October 21, 2025 14:20

link: review the request

baf7795

Signed-off-by: Josh Soref <[email protected]>

link: disable this feature

af11de1

Signed-off-by: Josh Soref <[email protected]>

link: OSF Storage capacity

fa6dcf0

Signed-off-by: Josh Soref <[email protected]>

link: Version history for this policy

a0b59f1

Signed-off-by: Josh Soref <[email protected]>

link: view it as a contributor

fcc4216

Signed-off-by: Josh Soref <[email protected]>

link: withdraw its parent registration

bfae29c

Signed-off-by: Josh Soref <[email protected]>

link: resend your confirmation email

812151f

Signed-off-by: Josh Soref <[email protected]>

link: set a password for your account

f85721f

Signed-off-by: Josh Soref <[email protected]>

link: approve this ...

4444950

Signed-off-by: Josh Soref <[email protected]>

link: cancel this ...

006ea2d

Signed-off-by: Josh Soref <[email protected]>

link: View your draft

9956d4e

Signed-off-by: Josh Soref <[email protected]>

jsoref added 11 commits October 21, 2025 14:20

link: Review and contribute to the updates in progress

20ded22

Signed-off-by: Josh Soref <[email protected]>

link: Review the updates in progress

7987bb9

Signed-off-by: Josh Soref <[email protected]>

link: Review and either approve or reject the submitted updates

67f21c6

Signed-off-by: Josh Soref <[email protected]>

link: Review the submited updates

68adcb4

Signed-off-by: Josh Soref <[email protected]>

link: about preregistration

e78d38f

Signed-off-by: Josh Soref <[email protected]>

link: how to upload a preprint

b3d8edd

Signed-off-by: Josh Soref <[email protected]>

link: create a registration

bf8f4c7

Signed-off-by: Josh Soref <[email protected]>

link: upload a preprint

debef3c

Signed-off-by: Josh Soref <[email protected]>

link: list of storage provider keys

3327d4a

Signed-off-by: Josh Soref <[email protected]>

Remove bogus aria-label

1a0c2af

Signed-off-by: Josh Soref <[email protected]>

link: Submitting to a Moderated Preprint Service

eabab52

Signed-off-by: Josh Soref <[email protected]>

jsoref force-pushed the accessible-links branch from 1f7e812 to eabab52 Compare October 21, 2025 18:20

jsoref commented Oct 21, 2025

View reviewed changes

jsoref requested a review from futa-ikeda October 21, 2025 18:24

futa-ikeda approved these changes Oct 21, 2025

View reviewed changes

futa-ikeda reviewed Oct 27, 2025

View reviewed changes

Accessible links #11369

Are you sure you want to change the base?

Accessible links #11369

Uh oh!

Conversation

jsoref commented Oct 16, 2025

Purpose

Do not use (click) here links

Changes

QA Notes

Documentation

Side Effects

Ticket

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

futa-ikeda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

futa-ikeda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

futa-ikeda left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Do not use `(click) here` links