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

Add storybook snapshot update command to testing documentation #3728

Merged
merged 3 commits into from Jan 31, 2024

Conversation

AetherUnbound
Copy link
Contributor

@AetherUnbound AetherUnbound commented Jan 31, 2024

Description

This came up in #3727 (comment).

This PR adds the storybook snapshot update command to the frontend testing documentation, so folks updating aspects of the frontend have all the necessary commands readily available in the same document.

I also removed all the preceding $ characters from these commands. Because they're of the console type (or perhaps just a code block in general), Sphinx makes it easy to copy the commands from the browser and paste into a shell. However, those commands come with the leading $ character too which makes them hard to paste and run immediately. This PR removes them all for this document, I'll have a follow up PR that removes them everywhere else.

Testing Instructions

View the generated documentation output and verify it looks correct.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate 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.
  • I ran the DAG documentation generator (if applicable).

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.

@AetherUnbound AetherUnbound requested a review from a team as a code owner January 31, 2024 18:08
@AetherUnbound AetherUnbound added 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 📄 aspect: text Concerns the textual material in the repository 🧱 stack: documentation Related to Sphinx documentation labels Jan 31, 2024
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/3728

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

Changed files 🔄:

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.

Thank you for updating the documentation!

@AetherUnbound
Copy link
Contributor Author

Okay, it looks like there's a difference in what's rendered when you remove the preceding $ 😕

Before
image

After
image

It copies easier, but it looks like all syntax is lost...going to try and see why that's the case. Otherwise I'll remove that commit from the PR.

@AetherUnbound
Copy link
Contributor Author

Ah! It looks like it's not console we want, it's bash. I'll update that here and change that in the other PR I'm making 🙂

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.

LGTM! It'll be helpful to also have documentation on how to update the snapshots for a single test.

@@ -17,39 +17,45 @@ Storybook visual regression tests, read

2. Run unit tests for the frontend.

```console
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 present in many other files too, would you mind opening an issue to fix these? It'll be a simple change that hopefully gives a new contributor a reason to set things up locally!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm about to drop another PR that fixes these and adds a pre-commit check for it, actually!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants