-
Notifications
You must be signed in to change notification settings - Fork 207
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
Conversation
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:
|
There was a problem hiding this 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
c206769
to
09244f3
Compare
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 ➕: |
documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md
Outdated
Show resolved
Hide resolved
documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md
Show resolved
Hide resolved
documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md
Outdated
Show resolved
Hide resolved
documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md
Outdated
Show resolved
Hide resolved
…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]>
I applied more changes. Please @zackkrida take another look. Two things remain:
|
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 |
There was a problem hiding this 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 :)
documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md
Outdated
Show resolved
Hide resolved
documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md
Show resolved
Hide resolved
This comment has been minimized.
This comment has been minimized.
Drafting in accordance with our policy on PRs getting reminders that still need changes. Just wanting to avoid unnecessary re-pings 🙂 |
I added content for all the suggestions. Please reviewers, take another look. |
documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Co-authored-by: zack <[email protected]>
There was a problem hiding this 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.
documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Olga Bulat <[email protected]>
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. |
Fixes #3894
Due date:
2024-03-27
Assigned reviewers
Description
This PR introduces the project proposal for the Dark mode project (#3592)