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.

Sign up for GitHub

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

Jump to bottom

Convert VContentLink story to MDX #1062

Merged
merged 3 commits into from
Apr 13, 2023
Merged

Convert VContentLink story to MDX #1062

merged 3 commits into from
Apr 13, 2023

Conversation

sepehrrezaei
Copy link
Contributor

Fixes

Related to #584 by @dhruvkb

Description

This PR updates the story of VContentLink to use the composition API (MDX). Here is the screenshot of the converted VContentLink to MDX in the storybook:
Screenshot 2023-03-29 at 14 14 23

Testing Instructions

Run the Storybook from this PR to see that VContentLink is working properly in the storybook.

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.

@sepehrrezaei sepehrrezaei requested a review from a team as a code owner March 29, 2023 12:22
@openverse-bot openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Mar 29, 2023
@obulat obulat added 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: frontend Related to the Nuxt frontend and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Mar 29, 2023
obulat
obulat requested changes Apr 3, 2023
View reviewed changes
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

The stories are great!

One change request here is to replace all instances of VContentList with VContentLink.

frontend/src/components/VContentLink/meta/VContentLink.stories.mdx Show resolved Hide resolved
@obulat obulat mentioned this pull request Apr 3, 2023
Closed
1 task
obulat
obulat approved these changes Apr 4, 2023
View reviewed changes
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Awesome, thank you for your contribution, @sepehrrezaei !

@obulat obulat force-pushed the convert_content_link_story_to_mdx branch from 9c61ad9 to 29802be Compare April 11, 2023 06:07
dhruvkb
dhruvkb requested changes Apr 11, 2023
View reviewed changes
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

This is really good! Thank you @sepehrrezaei. I do have some minor suggestions though.

frontend/src/components/VContentLink/meta/VContentLink.stories.mdx

<ArgsTable of={VContentLink} />

## Default VContentLink
Copy link
Member

Choose a reason for hiding this comment

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

Nit: VContentLink is implied here.

Suggested change
## Default VContentLink
## Default

frontend/src/components/VContentLink/meta/VContentLink.stories.mdx
<ArgsTable of={VContentLink} />

## Default VContentLink

Copy link
Member

Choose a reason for hiding this comment

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

Optional for this PR: a little description about each variant would be nice.

frontend/src/components/VContentLink/meta/VContentLink.stories.mdx
</Canvas>

## Mobile VContentLink

Copy link
Member

Choose a reason for hiding this comment

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

Please include a note that this story should be viewed in the Canvas tab. I was a bit confused when the "mobile" story was same as the desktop one when seen in the Docs tab.

frontend/src/components/VContentLink/meta/VContentLink.stories.mdx
<Story
name="Mobile"
parameters={{
viewport: { defaultViewport: "xs" },
Copy link
Member

Choose a reason for hiding this comment

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

This is a nice touch, thanks!

frontend/src/components/VContentLink/meta/VContentLink.stories.mdx

import VContentLink from "~/components/VContentLink/VContentLink.vue"

<Meta title="Components/VContentLink" components={VContentLink} argTypes={{}} />
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
<Meta title="Components/VContentLink" components={VContentLink} argTypes={{}} />
<Meta title="Components/VContentLink" component={VContentLink} />

dhruvkb
dhruvkb approved these changes Apr 13, 2023
View reviewed changes
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

Approving, shelving the recommended changes for future improvements.

@dhruvkb dhruvkb changed the title Convert VContentLink story to MDX Convert VContentLink story to MDX Apr 13, 2023
@dhruvkb dhruvkb merged commit cde702e into WordPress:main Apr 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dhruvkb dhruvkb dhruvkb approved these changes

@obulat obulat obulat approved these changes

@zackkrida zackkrida Awaiting requested review from zackkrida zackkrida is a code owner automatically assigned from WordPress/openverse-frontend

Assignees
No one assigned
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: frontend Related to the Nuxt frontend
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sepehrrezaei @obulat @dhruvkb @openverse-bot