Skip to content
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

Update empty state 404 documentation example to match new branding #5079

Merged
merged 7 commits into from
May 7, 2024

Conversation

jmuzina
Copy link
Member

@jmuzina jmuzina commented May 6, 2024

Done

Updates the empty state error management pattern to match the updated branding / copy seen on c.com.

Fixes WD-7904

QA

  • Open demo
  • Open c.com 404
  • Verify that the branding / copy matches between the error management empty state example and the c.com 404 page.

Check if PR is ready for release

If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:

  • PR should have one of the following labels to automatically categorise it in release notes:
    • Feature 🎁, Breaking Change 💣, Bug 🐛, Documentation 📝, Maintenance 🔨.
  • Vanilla version in package.json should be updated relative to the most recent release, following semver convention:
    • if CSS class names are not changed it can be bugfix relesase (x.x.X)
    • if CSS class names are changed/added/removed it should be minor version (x.X.0)
    • see the wiki for more details
  • Any changes to component class names (new patterns, variants, removed or added features) should be listed on the what's new page.

Screenshots

image

@webteam-app
Copy link

@jmuzina jmuzina requested a review from bartaz May 6, 2024 17:50
@jmuzina jmuzina changed the title Update empty state documentation examples to match new branding Update empty state 404 documentation example to match new branding May 6, 2024
@@ -6,15 +6,18 @@
{% block content %}
<section class="p-strip">
<div class="row">
Copy link
Member

Choose a reason for hiding this comment

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

It seems that the canonical.com version is using older (the "default") grid class names.

We could utilise the new "shorthand" layouts here.

So instead of having .row > .col-3.col-medium-2 + .col-9.col-medium-4, we could use the .row--25-75 > .col + .col - that should cover the responsiveness of the grid.

Suggested change
<div class="row">
<div class="row--25-75">

Copy link
Member Author

Choose a reason for hiding this comment

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

Made suggested changes to use new grid class names!

<div class="col-6 col-medium-3 u-vertically-center u-align--center">
<img src="https://assets.ubuntu.com/v1/03c7318e-image-404.svg" alt="Page not found" width="360" height="365">
<hr class="p-rule">
<div class="col-3 col-medium-2 col-medium-3 u-hide--small">
Copy link
Member

Choose a reason for hiding this comment

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

As per previous comment:

Suggested change
<div class="col-3 col-medium-2 col-medium-3 u-hide--small">
<div class="col u-hide--small">

<h1>404: Page not found</h1>
<p class="p-heading--4">Sorry, we couldn’t find that page.</p>
</div>
<div class="col-9 col-medium-4">
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<div class="col-9 col-medium-4">
<div class="col">

Copy link
Contributor

@lyubomir-popov lyubomir-popov left a comment

Choose a reason for hiding this comment

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

very close, couple of small suggestions to bring it in line with current design thinkin:

  • remove the horixontal rule (no need as it is the first thing after the header)
    image
  • replace p-strip with p-section--hero, which is a new component we use for the section on the page containing the h1 heading

@@ -5,16 +5,19 @@

{% block content %}
<section class="p-strip">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<section class="p-strip">
<section class="p-section--hero">

<div class="col-6 col-medium-3 u-vertically-center u-align--center">
<img src="https://assets.ubuntu.com/v1/03c7318e-image-404.svg" alt="Page not found" width="360" height="365">
<div class="row--25-75">
<hr class="p-rule">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<hr class="p-rule">

Copy link
Member

@bartaz bartaz left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -58,6 +58,10 @@ To import either or all of these components into your project, copy the snippets

// dependencies for user action triggered empty state example
@include vf-u-vertically-center;
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for remembering to update this section as well. I think we don't need vf-u-vertically-center anymore (class name was removed from the example), and the comment above it is misleading I guess (it's a copy of a comment above). I think it was meant to refer to error management example

@@ -18,3 +18,7 @@

// dependencies for user action triggered empty state example
@include vf-u-vertically-center;
Copy link
Member

Choose a reason for hiding this comment

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

As commented in the documentation, this is probably not needed anymore?

@jmuzina jmuzina merged commit e6d414d into canonical:main May 7, 2024
5 checks passed
@jmuzina jmuzina deleted the update-empty-state branch May 7, 2024 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants