openverse icon indicating copy to clipboard operation
openverse copied to clipboard

Move brand directory to documentation

Open tammytdo opened this issue 1 year ago • 7 comments

Fixes

Fixes https://github.com/WordPress/openverse/issues/777 by @dhruvkb

Description

Moves the brand directory into documentation site.

Testing Instructions

Checklist

  • [x] My pull request has a descriptive title (not a vague title likeUpdate 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.
  • [ ] 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.
  • [ ] 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.

tammytdo avatar Apr 08 '24 23:04 tammytdo

This PR references Collect documentation inside Sphinx #777

tammytdo avatar Apr 08 '24 23:04 tammytdo

I will unassign myself as a reviewer because I can't provide proper feedback on the work made.

fcoveram avatar Apr 09 '24 08:04 fcoveram

@sarayourfriend Updates pushed. Thank you for the images and extra clear summary!

tammytdo avatar Apr 18 '24 07:04 tammytdo

@AetherUnbound Do you think it's worth revisiting the archived DAGs generally, at this point, and seeing if we can just remove the code altogether? If it absolutely needs to be easy to access, the old and archived WordPress/openverse-catalog repository would continue to have that code, but we could also zip it up and upload it somewhere if needed. Not work for this PR, but asking in case you think it's worth opening an issue for it.

sarayourfriend avatar Apr 23 '24 04:04 sarayourfriend

@sarayourfriend concerning the archived dags I think they should be removed, and we perhaps add a line in our documentation somewhere linking to a git commit which still contains those files.

zackkrida avatar Apr 23 '24 14:04 zackkrida

Having now been several years out from the decision to go with an archive/ directory, I think it's very safe to just remove it wholesale at this point. Part of my hesitancy in doing so was not wanting to delete major parts of the codebase without getting more context, even if they weren't being used at the time. But because it's been so long and we've shown it's really not necessary, I am fully on board with getting rid of it!

AetherUnbound avatar Apr 23 '24 15:04 AetherUnbound

@tammytdo thanks again for working on this issue. Will you be able to implement the requested changes? If not, please let us know and one of the maintainers can update it with the requested changes to get it re-reviewed and merged.

sarayourfriend avatar May 01 '24 21:05 sarayourfriend

I'm going to get this PR rebased and ready for review again. Thanks for kicking it off @tammytdo! I'll take it from here :slightly_smiling_face:

sarayourfriend avatar May 08 '24 01:05 sarayourfriend

@dhruvkb @AetherUnbound if either of y'all can give a :+1: here, please feel free to merge after doing so.

Thanks again @tammytdo!

sarayourfriend avatar May 08 '24 01:05 sarayourfriend