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

Project proposal for dark mode project #3913

Merged
merged 15 commits into from
Mar 25, 2024
Merged

Conversation

fcoveram
Copy link
Contributor

@fcoveram fcoveram commented Mar 13, 2024

Fixes #3894

Due date:

2024-03-27

Assigned reviewers

Description

This PR introduces the project proposal for the Dark mode project (#3592)

@fcoveram fcoveram requested a review from a team as a code owner March 13, 2024 21:02
@github-actions github-actions bot added the 🧱 stack: documentation Related to Sphinx documentation label Mar 13, 2024
@fcoveram fcoveram changed the title Project proposal Project proposal for dark mode project Mar 13, 2024
@fcoveram fcoveram added the 🧭 project: proposal A proposal for a project label Mar 13, 2024
@openverse-bot openverse-bot added the 🏷 status: label work required Needs proper labelling before it can be worked on label Mar 13, 2024
@fcoveram fcoveram added 📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon labels Mar 13, 2024
@fcoveram fcoveram requested review from zackkrida and obulat and removed request for krysal and sarayourfriend March 13, 2024 21:13
@fcoveram fcoveram linked an issue Mar 13, 2024 that may be closed by this pull request
@fcoveram
Copy link
Contributor Author

I assign you @zackkrida and @obulat thinking that you might have time to review the document and include additional info I typed as TBD.

The two points missing details are:

  • Define the implementation participant.
  • Specify infrastructure changes, if needed.

@fcoveram fcoveram mentioned this pull request Mar 6, 2024
9 tasks
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.

I'll try to review the plan this week.

Could you add an index.md file with the following contents:

Dark Mode

:titlesonly:
:glob:
*

This will fix the documentation build and then we'll see the built project proposal in a link in a comment on this PR.

Note: I copied the file contents from https://github.com/WordPress/openverse/pull/1176/files

@obulat obulat force-pushed the project-proposal-for-dark-mode branch from c206769 to 09244f3 Compare March 14, 2024 18:27
Copy link

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

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.

New files ➕:

@zackkrida zackkrida requested a review from obulat March 18, 2024 15:31
fcoveram and others added 3 commits March 19, 2024 10:48
…oposal_dark_mode.md


Replacing word "people" with "user"

Co-authored-by: zack <[email protected]>
…oposal_dark_mode.md


Adding details about infrastructure changes

Co-authored-by: zack <[email protected]>
@fcoveram
Copy link
Contributor Author

I applied more changes. Please @zackkrida take another look.

Two things remain:

  1. Is it ok if I add you @obulat as implementer? If not, I would like suggestions for who can address it.
  2. I created an issue in marketing repo requesting suggestions for ideas, but if team members don't arrive timely, I think is fine to continue with the project and include the campaign description once we have it.

@fcoveram fcoveram requested a review from zackkrida March 20, 2024 11:16
@obulat obulat removed the 🏷 status: label work required Needs proper labelling before it can be worked on label Mar 20, 2024
@zackkrida
Copy link
Member

zackkrida commented Mar 20, 2024

Hi @fcoveram I have reviewed again and still have some small changes. I apologize if it seems I am being nit-picky. This plan is a bit more brief than the ones we typically write, which is fine, but I do want to make sure we are capturing your intentions for the project as clearly as possible now so the project is easy for anyone to implement later.

As for the implementers, I think putting the @WordPress/openverse-frontend team will be fine.

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.

I can be the implementer, @fcoveram :)

@openverse-bot

This comment has been minimized.

@sarayourfriend sarayourfriend marked this pull request as draft March 22, 2024 00:57
@sarayourfriend
Copy link
Collaborator

sarayourfriend commented Mar 22, 2024

Drafting in accordance with our policy on PRs getting reminders that still need changes. Just wanting to avoid unnecessary re-pings 🙂

@fcoveram fcoveram requested a review from obulat March 22, 2024 14:42
@fcoveram
Copy link
Contributor Author

I added content for all the suggestions. Please reviewers, take another look.

@fcoveram fcoveram marked this pull request as ready for review March 25, 2024 10:51
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.

LGTM!

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 plan looks great!

I kind of wish we updated the last section to "Required implementation plans and design proposals" because the IP and design proposals can be prepared by different people, and can sometimes work in parallel.

@fcoveram
Copy link
Contributor Author

In this case, designs are specified in the requirements list, but it could be better to create a new section called "Required designs" and point out whether the project needs designs for specific pages or components. Mixing it with the implementation plans might be confusing as plans outline the changes needed in advance.

I'd appreciate if you can create that issue requesting the change. As for this PR, I will continue with merging it.

@fcoveram fcoveram merged commit 8ee33a6 into main Mar 25, 2024
38 checks passed
@fcoveram fcoveram deleted the project-proposal-for-dark-mode branch March 25, 2024 15:22
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: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧭 project: proposal A proposal for a project 🧱 stack: documentation Related to Sphinx documentation
Projects
Status: Accepted
Archived in project
Development

Successfully merging this pull request may close these issues.

Project Proposal: Dark Mode
5 participants