openverse-frontend icon indicating copy to clipboard operation
openverse-frontend copied to clipboard

Always clean up docker container on exit, add caveat to README

Open AetherUnbound opened this issue 3 years ago • 1 comments

Description

As part of testing out #1717, I noticed two things:

  1. The provided docker run command didn't clean up after itself.
  2. I instinctively tried to use the link that Nuxt provided, only to find that I ran into some really wacky cert issues when I did. Since I had only peaked at the docker steps and not the HTTPS setup, I added a caveat (which sort of mirrors the https notes) not to use the link Nuxt provides.

If the second point is one y'all think others won't run into, we can drop that commit. It might just be my unfamiliarity with the frontend & only reading the part of the README that seemed it would get me up and running :slightly_smiling_face:

Testing Instructions

Run the altered command, stop the container, and ensure it no longer exists afterwards.

Checklist

  • [x] My pull request has a descriptive title (not a vague title like Update index.md).
  • [x] My pull request targets the default branch of the repository (main) or a parent feature branch.
  • [x] My commit messages follow best practices.
  • [x] My code follows the established code style of the repository.
  • [ ] I added or updated tests for the changes I made (if applicable).
  • [x] I added or updated documentation (if applicable).
  • [x] 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.

AetherUnbound avatar Aug 30 '22 18:08 AetherUnbound

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1762 Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1762/tailwind

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.

github-actions[bot] avatar Aug 30 '22 18:08 github-actions[bot]