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

feat: course about page markup and styles improvements #33712

Merged

Conversation

bydawen
Copy link
Contributor

@bydawen bydawen commented Nov 14, 2023

Similar PR is opened to the open-release/palm branch:
#33711

There is some fixes for the course about page:

  • display a course short description in course about heading-group (if necessary)
  • removing duplicated pre-requisite info in right sidebar
  • code formatting for the block % if get_course_about_section(request, course, "prerequisites"):

Fixes were also made to the _course_about.scss styles, to fix responsive layout of the course about header element.

Before fixes:
1_before

After fixes:
2_after

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 14, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 14, 2023

Thanks for the pull request, @bydawen!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@bydawen
Copy link
Contributor Author

bydawen commented Nov 14, 2023

Hi! I'm contributing on behalf of Raccoongang

@dyudyunov dyudyunov force-pushed the feat/master/course-about-page-markup branch from edcf611 to 01a3a0a Compare November 23, 2023 12:20
@cmltaWt0 cmltaWt0 added the product review PR requires product review before merging label Feb 8, 2024
@mphilbrick211 mphilbrick211 added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Feb 21, 2024
@farhaanbukhsh
Copy link
Member

@mphilbrick211 I can take this as a CC review once the product review is done. :)

@mphilbrick211
Copy link

@mphilbrick211 I can take this as a CC review once the product review is done. :)

Thank you, @farhaanbukhsh!

@ali-hugo ali-hugo self-requested a review March 13, 2024 09:17
@ali-hugo
Copy link

@bydawen Thank you for this contribution! I'll be performing the product review. A few notes/questions:

  • The layout of the header looks much better! 👏
  • I think the hierarchy of the organization name ("edX") and the course short description is too similar. Could they be styled differently to make the difference in hierarchy more clear?
  • Could you please post a screenshot of the pre-requisite info that you removed from the sidebar? I don't see any duplication on the current About page that I have access to

Thank you.

@mphilbrick211 mphilbrick211 removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Mar 13, 2024
@farhaanbukhsh
Copy link
Member

Hey @bydawen any updates here?

@ihor-romaniuk ihor-romaniuk force-pushed the feat/master/course-about-page-markup branch from 77e7538 to 53e9ea0 Compare April 18, 2024 15:29
@ihor-romaniuk
Copy link
Contributor

Hello @ali-hugo

  • regarding the organization name (“edX”), I put it in the sidebar with similar information about the course, I think that there it is more appropriate in terms of the page structure and information (screen mark #1)
  • regarding prerequisites, the org course + course number was removed, but it seems that we should leave it as is. (I returned it as it was) (screen mark #2)
image

@ali-hugo
Copy link

Hi @ihor-romaniuk,

I think having the organisation name in the sidebar works well on desktop, but I wonder if it is too far down on the page on mobile. Perhaps the sidebar information should be moved above the "about this course" section on mobile. @jmakowski1123 Would you be happy with that from a UX perspective?

@jmakowski1123
Copy link

Hi @ihor-romaniuk,

I think having the organisation name in the sidebar works well on desktop, but I wonder if it is too far down on the page on mobile. Perhaps the sidebar information should be moved above the "about this course" section on mobile. @jmakowski1123 Would you be happy with that from a UX perspective?

Tagging @marcotuts to make the call about mobile UI.

@mphilbrick211
Copy link

Hi @ihor-romaniuk,
I think having the organisation name in the sidebar works well on desktop, but I wonder if it is too far down on the page on mobile. Perhaps the sidebar information should be moved above the "about this course" section on mobile. @jmakowski1123 Would you be happy with that from a UX perspective?

Tagging @marcotuts to make the call about mobile UI.

Hi @marcotuts! Friendly follow-up on this.

@marcotuts
Copy link
Contributor

My suggestion here is to put more space betweeen the org and the description, 20px perhaps minimum.

Another suggestion is to put the org above the title, which echoed the design of many other course cards with org (in small text) then course title (larger text) then fellow that description or subtitle like content .

Hopefully this helps!

@ihor-romaniuk
Copy link
Contributor

@marcotuts, per your recommendations, I moved the organization name above the course title to match the style of the course cards.
image

@ihor-romaniuk
Copy link
Contributor

Backport to Redwood: #34892

@marcotuts
Copy link
Contributor

marcotuts commented Jun 4, 2024

update: Product review is done here, this can move to the next step thanks!

@idegtiarov
Copy link
Contributor

@farhaanbukhsh Hey, the product review has been passed! Will you be able to do a tech review?

@idegtiarov
Copy link
Contributor

@ihor-romaniuk please rebase your branch

@ihor-romaniuk ihor-romaniuk force-pushed the feat/master/course-about-page-markup branch 2 times, most recently from d7d44ba to 6ca7e4e Compare July 31, 2024 11:05
@ihor-romaniuk
Copy link
Contributor

The branch is up-to-date.

@mphilbrick211 mphilbrick211 added product review complete PR has gone through product review and removed product review PR requires product review before merging labels Jul 31, 2024
@mphilbrick211
Copy link

@idegtiarov @ihor-romaniuk will you also be able to take of the backports?
#34892
#33791

@ihor-romaniuk ihor-romaniuk force-pushed the feat/master/course-about-page-markup branch from 6ca7e4e to d440068 Compare August 7, 2024 18:10
@ihor-romaniuk
Copy link
Contributor

@mphilbrick211 All PRs were updated and ready for review or merge. Thanks.

@farhaanbukhsh
Copy link
Member

Thanks @ihor-romaniuk I will have a look at it early next week :)

@ihor-romaniuk ihor-romaniuk force-pushed the feat/master/course-about-page-markup branch from d440068 to 23a25a3 Compare August 15, 2024 15:35
@ihor-romaniuk ihor-romaniuk force-pushed the feat/master/course-about-page-markup branch from 23a25a3 to 5ef014a Compare September 3, 2024 15:19
@ihor-romaniuk
Copy link
Contributor

@farhaanbukhsh I believe everything is ready for the final review and merging of this pull request. Could we proceed with that?

@farhaanbukhsh
Copy link
Member

@ihor-romaniuk sure I will try to get this merged today or tomorrow :)

Copy link
Member

@farhaanbukhsh farhaanbukhsh left a comment

Choose a reason for hiding this comment

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

👍

  • ✅ I tested this on tutor master devstack and it is working
  • ✅ I read through the code
  • ❌ I checked for accessibility issues
  • ❌ Includes documentation

@farhaanbukhsh farhaanbukhsh merged commit 483315c into openedx:master Sep 9, 2024
49 checks passed
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U product review complete PR has gone through product review
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.