Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Content page component design fixes #1172

Merged
merged 9 commits into from
Mar 24, 2022

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Mar 23, 2022

Fixes

Fixes #1090 by @zackkrida

Description

This PR attempts to finish up the work started in #1093 to get it merged :)
It merges main and applies the following #1093 code review suggestions:

On desktop

  • Margin bottom of h1 set to 40px.
  • Margin top of h3 set to 40px.
  • Links in main content only have an underline style on hover.
  • In the table, labels in header cells are description bold style.
  • In the table, texts in cells are description regular style.
  • External icon in main CTA in sources uses correct icon.

On mobile

  • h1, h3 styles updated

The following suggestions were not implemented:

  • Mobile paragraph styles not updated.
  • The table layout on mobile is unchanged.

Other changes:

  • scss removed from the pages styles
  • VContentPage name added so that it can be imported in the components.

Testing Instructions

Check that the content pages look similar to the Sources page mockup, and are not broken.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

zackkrida and others added 4 commits March 9, 2022 16:04
@obulat obulat added 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 🕹 aspect: interface Concerns end-users' experience with the software labels Mar 23, 2022
@obulat obulat added this to the Remove Sass and legacy styles milestone Mar 23, 2022
@obulat obulat requested a review from a team as a code owner March 23, 2022 10:40
@zackkrida zackkrida changed the base branch from content-page-component to main March 23, 2022 12:56
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Wow, thanks! I changed the base branch to main, otherwise there were 392 files to review 😅 . We can just merge this as a replacement to #1093 I think.

The changes look perfect to me; LGTM!

Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

Tested locally and looks good to me. One question before approving but otherwise looks good.

src/components/VContentPage.vue Outdated Show resolved Hide resolved
tailwind.config.js Show resolved Hide resolved
obulat and others added 2 commits March 23, 2022 17:17
Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>
@zackkrida
Copy link
Member

@sarayourfriend could you re-review this one before your time off? seems like a quick win.

<template>
<div class="pt-5 md:pt-10" dir="ltr">
<div
class="px-6 lg:px-0 mb-10 lg:mb-30 md:max-w-4xl xl:max-w-5xl prose prose-sm md:prose-base mx-auto max-w-none prose-headings:font-bold lg:prose-headings:text-3xl prose-h1:text-4xl prose-h1:text-bold lg:prose-h1:text-6xl md:prose-h1:mb-10 prose-h3:text-2xl prose-h3:font-semibold md:prose-h3:mt-10"
Copy link
Contributor

Choose a reason for hiding this comment

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

This massive list of prose-* classes also scares me. It has all the features of the worst parts of Tailwind IMO (namely, a super long and inscrutable list of class names that are difficult to edit, read, and get a full picture of).

Adding our own prose class to tailwind.css with these styles using the @apply rule would probably be easier to read and maintain 🤷 Just my own feeling about this plugin though.

Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

The pages LGTM. I don't really like the plugin but I can see that it makes things easier here in some sense (though IMO harder long term) so I won't block on it.

@zackkrida
Copy link
Member

@sarayourfriend the primary reason I'd like to use the plugin is so we have more raw html tags in use and can easily replace things, like <h1> ~> <Heading level="1"> or whatever if and when we make our design system more robust, instead of having to do a bunch of manual work or, god forbid, regex matching on html tags with classes and other attributes. Your thoughts are well-received!

@zackkrida zackkrida merged commit 2679c12 into main Mar 24, 2022
@zackkrida zackkrida deleted the content-page-component-design-fixes branch March 24, 2022 15:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🕹 aspect: interface Concerns end-users' experience with the software 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create VContentPage component
3 participants