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

Information Architecture Refactor: Update the Plan > Lesson Summary #12730

Merged
merged 15 commits into from
Oct 25, 2024

Conversation

AlexVelezLl
Copy link
Member

Summary

Update the Plan > Lesson Summary page to reflect both planning and report elements.

References

Closes #12707

Reviewer guidance

  • Does the coach plan lessons follows the behaviour described in the specs?

Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@github-actions github-actions bot added DEV: backend Python, databases, networking, filesystem... APP: Coach Re: Coach App (lessons, quizzes, groups, reports, etc.) DEV: frontend labels Oct 22, 2024
@marcellamaki marcellamaki self-requested a review October 22, 2024 13:46
@marcellamaki
Copy link
Member

@radinamatic @pcenov - if we can get QA review here, that would be great. Peter, the focus can be on overall alignment to the spec. Radina, a focus on any accessibility regressions in particular would be helpful! Thank you :)

@pcenov
Copy link
Member

pcenov commented Oct 23, 2024

Hi @AlexVelezLl, I was able to identify the following minor differences with the spec:

  1. The title of the lesson is not centered and it should be checked whether the icon and text size are ok.
  2. I don't see the 'Made visible {date} ago' text - is this part of a separate PR?
  3. The position of the header row of the table and also the missing underline.
  4. The spacing between the labels and the text in the sidebar is not the same as in the Figma frame.

lesson summary

@AlexVelezLl
Copy link
Member Author

AlexVelezLl commented Oct 23, 2024

Thank you @pcenov!

  1. Let me check this.
  2. Let me check this with the team.
  3. I think this line can be ignored for now, as this is part of the current table and I think updating this style is out of scope for now, right @marcellamaki?
  4. Will fix this!

@AlexVelezLl
Copy link
Member Author

Hi @pcenov I have fixed the point 1, and point 4. I have fixed the alignment between the title and the actions, and fixed the font size.

I discussed with the team and they said that point 2 can be managed in a follow up issue to further discuss the implications of introducing it.

@marcellamaki
Copy link
Member

Yes - thank you @AlexVelezLl! confirming points 2 & 3 will be managed separately. I'll prioritize code review on this tomorrow, and Peter if you are able to re-review Alex's changes for items 1 and 4, that would be helpful. Thank you both

@radinamatic
Copy link
Member

No regressions or errors observed while navigating by keyboard through this new Plan >Lesson summary page. All interactive elements are focusable in a meaningful order, and actionable as expected.

However, 3 elements are missing the label (accessible text):

Options button Remove button Visibility toggle
2024-10-24_14-10-20 2024-10-24_14-12-45 2024-10-24_14-13-35

@radinamatic
Copy link
Member

One thing is pre-existing, and we will report separately: the issue of the UNDO button inside the snackbar that appears when a resource is removed, and it needs to be put in focus immediately after the deletion.

@pcenov
Copy link
Member

pcenov commented Oct 24, 2024

Hi @AlexVelezLl - I confirm that point 1 is fixed but for point 4 what I meant is that there should be more space between the label and the text below it in the side panel. Here's a screenshot:

side panel

@AlexVelezLl
Copy link
Member Author

AlexVelezLl commented Oct 24, 2024

Thank you @radinamatic! I just added the aria labels for the options and remove buttons. For the switch one I will create a follow up in KDS as we wll need to fix this there (learningequality/kolibri-design-system#806, #12743).

And @pcenov, I have updated the margins according to the specs:
image

Copy link
Member

@radinamatic radinamatic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing button labels added, margins according to specs, all issues addressed, and follow-up issue filed! 👏🏽

Excellent job, @AlexVelezLl! 💯 :shipit:

Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a quick skim, and nothing jumped out at me, but it was by no means a comprehensive review.

@@ -2963,15 +2963,6 @@ anymatch@^3.0.3, anymatch@~3.1.2:
normalize-path "^3.0.0"
picomatch "^2.0.4"

"aphrodite@git+https://github.com/learningequality/aphrodite.git":
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like dependabot was responsible for adding this - I am not sure why it does!

Copy link
Member Author

@AlexVelezLl AlexVelezLl Oct 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I have the sense that we have had removed this a couple of times already 😅/

},
);
},
async handleResourcesChange({ newArray }) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of the work here to handle the resource management within the table, while certainly implied by/part of the spec, is tough, and you did a great job with it. It's a lot more complicated than it would seem just by looking at the UI. And I really like the addition of the snackbar here and the undo action. It adds complexity but a really thoughtful implementation for the user perspective.

computed: {
...mapState('classSummary', { className: 'name' }),
},
methods: {
handleDragStart() {
// Used to mitigate the issue of text being selected while dragging
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the upgrade to using @mousedown.prevent here is a small change but so nice

Copy link
Member

@marcellamaki marcellamaki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @AlexVelezLl - this looks great, no concerns on my end, and some of the work here is just really thoughtful implementation and interpretation of the spec. Possibly you may end up wanting to make some further tweaks on this as the IA work wraps up, but that's fine with me, and we can continue any discussions about expected behavior as the work progresses. Nicely done!

@marcellamaki marcellamaki merged commit 9f045f7 into learningequality:develop Oct 25, 2024
34 checks passed
@AlexVelezLl AlexVelezLl deleted the update-lesson-coach branch October 25, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APP: Coach Re: Coach App (lessons, quizzes, groups, reports, etc.) DEV: backend Python, databases, networking, filesystem... DEV: frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the Plan > Lesson Summary page to reflect both planning and report elements
5 participants