Skip to content

feat(help): apply updated design to Webhooks Start page #5855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

nazarbodak221
Copy link

@nazarbodak221 nazarbodak221 commented Jul 1, 2025

Applied the new visual design to the Webhooks Getting Started page (v2_webhooks-getting-started.html)

Screenshot of updated design:

image

Refs: #5353

Applied the new visual design to the Webhooks Getting Started page (`v2_webhooks-getting-started.html`)

Refs: freelawproject#5353
@mlissner mlissner requested a review from elisa-a-v July 1, 2025 13:30
@mlissner mlissner moved this to To Do in Sprint (Web Team) Jul 1, 2025
@nazarbodak221 nazarbodak221 marked this pull request as draft July 2, 2025 10:43
@nazarbodak221 nazarbodak221 changed the title style(help): apply updated design to Webhooks Start page feat(help): apply updated design to Webhooks Start page Jul 11, 2025
Adds an attention-grabbing comment to the old version of the template.
@nazarbodak221 nazarbodak221 marked this pull request as ready for review July 11, 2025 11:06
Copy link
Contributor

@elisa-a-v elisa-a-v left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, thanks! However, as with the previous review, this one also doesn't show even when the flag is active. This will probably require the same fix as that one, since both handle template name the same way.

<li>Your application should use the <a class="underline" href="{% url 'webhooks_docs' %}#headers">Idempotency-Key included in the event headers</a> to ensure that it only processes the event once.</li>
</ul>
<p>Below are examples of endpoints configured in Flask and Django</p>
<p><strong>Flask</strong></p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think <h3> is more semantically correct here than <p><strong>:

Suggested change
<p><strong>Flask</strong></p>
<h3>Flask</h3>

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, that makes sense, I'll change it.

print(request.json)
return Response(status=200)
</c-code>
<p><strong>Django</strong></p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here:

Suggested change
<p><strong>Django</strong></p>
<h3>Django</h3>

@elisa-a-v elisa-a-v moved this from To Do to Blocked in Sprint (Web Team) Jul 11, 2025
@nazarbodak221
Copy link
Author

Looks good overall, thanks! However, as with the previous review, this one also doesn't show even when the flag is active. This will probably require the same fix as that one, since both handle template name the same way.

I change middleware to fix it, but to be honest I don't know where to commit, in every branch, or make a PR for this change, because it should be in each PR

Replaced a <p> with a nested <strong> tag with a more semantically correct <h3> heading.
@elisa-a-v
Copy link
Contributor

or make a PR for this change

This sounds great! Could you open a PR to update the middleware to support these views please? Then we can merge that first, and the rest should work :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Blocked
Development

Successfully merging this pull request may close these issues.

2 participants