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.

Sign up for GitHub

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

Jump to bottom

Create a DR for _project-page.scss #3990

Closed
10 tasks done
jdingeman opened this issue Feb 17, 2023 · 6 comments
Closed
10 tasks done

Create a DR for _project-page.scss #3990

jdingeman opened this issue Feb 17, 2023 · 6 comments
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Wiki role: back end/devOps Tasks for back-end developers size: 0.5pt Can be done in 3 hours or less
Projects
Project Board
Milestone
08. Team workflow

Comments

@jdingeman
Copy link
Member

jdingeman commented Feb 17, 2023 •
edited by kurikurichan

Overview

Action Items

  • We are currently in the process of moving the old wiki to the new website-wiki repo, so we will not be making any changes or additions to the old wiki at this time. Thus, we will be adding wiki content through a different process now. Read How to Contribute to the Wiki
  • Create a new Decision Record in the Wiki for the solution adopted in the pull request.
    • The reason this should be documented is since the Project, Solution, and Impact card could potentially be a reusable component in the future, we would want to have its style be a part of a parent class (i.e. a new .scss file specific to the card) to access later
    • This would potentially involve creating a new .html component that holds the layout of the card, which would then be used in a Liquid include statement in the layout of the project.html
  • Document the changes made in the _project-page.scss file specific to the Problem, Solution, and Impact card
  • Add a link to the DR in the Decision Records on Solutions Adopted
  • When finished with the Decision Record:
    • Place this issue into the Questions / In Review column
    • Add a "ready for dev lead" label
    • Notify merge team/tech leads to review

Resources/Instructions
@github-actions github-actions bot added Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing labels Feb 17, 2023
@jdingeman jdingeman changed the title Create a DR for Create a DR for _project-page.scss Feb 17, 2023
@jdingeman jdingeman added role: back end/devOps Tasks for back-end developers Feature: Wiki Complexity: Small Take this type of issues after the successful merge of your second good first issue size: 0.5pt Can be done in 3 hours or less Draft Issue is still in the process of being created ready for dev lead Issues that tech leads or merge team members need to follow up on and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing labels Feb 17, 2023
@jdingeman
Copy link
Member Author

Will complete this issue when I have clarification of this [comment].(#3547 (comment))

@jdingeman jdingeman added Ready for Prioritization and removed ready for dev lead Issues that tech leads or merge team members need to follow up on Draft Issue is still in the process of being created labels Mar 1, 2023
@jdingeman jdingeman added this to New Issue Approval in Project Board via automation Mar 1, 2023
@jdingeman jdingeman mentioned this issue Mar 3, 2023
Closed
8 tasks
@ExperimentsInHonesty ExperimentsInHonesty added this to the 08. Team workflow milestone Mar 5, 2023
@ExperimentsInHonesty ExperimentsInHonesty moved this from New Issue Approval to Prioritized backlog in Project Board Mar 5, 2023
@kurikurichan kurikurichan self-assigned this Apr 20, 2023
@github-actions
Copy link

Hi @kurikurichan, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

@kurikurichan kurikurichan moved this from Prioritized backlog to In progress (actively working) in Project Board Apr 20, 2023
@kurikurichan
Copy link
Member

Provide Update

  1. Progress - Starting on it- going to look at other DR's for proper formatting
  2. Blockers - Mainly just working up the mental energy to look at the other DR's and really analyze them
  3. Availability - Weekdays this week (so just not Sunday really)
  4. ETA - I think I can have it done by Tuesday at the latest, I don't think it will actually take long once I focus on it

@kurikurichan
Copy link
Member

kurikurichan commented Apr 28, 2023 •
edited

Comment draft:

This is a record in the Decision Records on Solutions Adopted.

Issue

Problem Statement

  • We want a resuable component that displays on specific project pages that have problem, solution, and impact fields.

Potential Solution

  • A style was implemented in the _project-page.scss file.

Feasibility Determination

  • To use the new styles, developers can use the recently added classes such as: .project-page-value-description, .sdg-card--title, .sdg-grid-item, .sdg-description-wrapper, and .sdg-description-card.

Summary

  • We needed an additional section on the project pages that displayed the Problem, Solution, Impact section, as originally requested in issue Add Problem, Solution, and Impact Sections to Project Pages #3547. After a solution was implemented, it was decided in issue Create a DR for _project-page.scss #3990 to make that styled component resuable.
  • We could have created a parent class (i.e. a new .scss file specific to the card) for the style, to access later. However, it was decided to instead create a style in the _project-page.scss file.
  • If using the parent class method instead, we would potentially have had to create a new .html component that held the layout of the card, which would then have been used in a Liquid include statement in the layout of the project.html.

@kurikurichan kurikurichan moved this from In progress (actively working) to Questions / In Review in Project Board Apr 28, 2023
@kurikurichan
Copy link
Member

kurikurichan commented Apr 28, 2023 •
edited

I followed the instructions for the new website-wiki repo and put my draft in the comment above. @jdingeman @roslynwythe , please let me know if there's anyone else I should ping/notify

@kurikurichan kurikurichan added the ready for dev lead Issues that tech leads or merge team members need to follow up on label May 2, 2023
@jdingeman
Copy link
Member Author

Hi @kurikurichan, thank you! Closing this so you can move on to a new issue.

Project Board automation moved this from Questions / In Review to QA May 2, 2023
@HackforLABot HackforLABot moved this from QA to Done in Project Board May 2, 2023
@jdingeman jdingeman removed the ready for dev lead Issues that tech leads or merge team members need to follow up on label May 2, 2023
@kurikurichan kurikurichan removed their assignment May 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Wiki role: back end/devOps Tasks for back-end developers size: 0.5pt Can be done in 3 hours or less
Projects
Project Board
  
Done
Milestone
08. Team workflow
Development

No branches or pull requests
3 participants
@kurikurichan @ExperimentsInHonesty @jdingeman