edx-platform icon indicating copy to clipboard operation
edx-platform copied to clipboard

feat: course about page markup and styles improvements

Open bydawen opened this issue 1 year ago • 22 comments

Similar PR is opened to the open-release/palm branch: https://github.com/openedx/edx-platform/pull/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

bydawen avatar Nov 14 '23 15:11 bydawen

Thanks for the pull request, @bydawen!

What's next?

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

:radio_button: 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.

:radio_button: 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

:radio_button: 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.

:radio_button: 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

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

openedx-webhooks avatar Nov 14 '23 15:11 openedx-webhooks

Hi! I'm contributing on behalf of Raccoongang

bydawen avatar Nov 14 '23 15:11 bydawen

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

farhaanbukhsh avatar Mar 07 '24 15:03 farhaanbukhsh

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

Thank you, @farhaanbukhsh!

mphilbrick211 avatar Mar 08 '24 20:03 mphilbrick211

@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.

ali-hugo avatar Mar 13 '24 09:03 ali-hugo

Hey @bydawen any updates here?

farhaanbukhsh avatar Mar 30 '24 05:03 farhaanbukhsh

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

ihor-romaniuk avatar Apr 18 '24 15:04 ihor-romaniuk

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?

ali-hugo avatar Apr 22 '24 07:04 ali-hugo

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.

jmakowski1123 avatar Apr 23 '24 13:04 jmakowski1123

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.

mphilbrick211 avatar May 10 '24 20:05 mphilbrick211

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!

marcotuts avatar May 10 '24 20:05 marcotuts

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

ihor-romaniuk avatar May 23 '24 08:05 ihor-romaniuk

Backport to Redwood: https://github.com/openedx/edx-platform/pull/34892

ihor-romaniuk avatar Jun 03 '24 08:06 ihor-romaniuk

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

marcotuts avatar Jun 04 '24 14:06 marcotuts

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

idegtiarov avatar Jul 31 '24 10:07 idegtiarov

@ihor-romaniuk please rebase your branch

idegtiarov avatar Jul 31 '24 10:07 idegtiarov

The branch is up-to-date.

ihor-romaniuk avatar Jul 31 '24 11:07 ihor-romaniuk

@idegtiarov @ihor-romaniuk will you also be able to take of the backports? https://github.com/openedx/edx-platform/pull/34892 https://github.com/openedx/edx-platform/pull/33791

mphilbrick211 avatar Jul 31 '24 19:07 mphilbrick211

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

ihor-romaniuk avatar Aug 07 '24 18:08 ihor-romaniuk

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

farhaanbukhsh avatar Aug 08 '24 07:08 farhaanbukhsh

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

ihor-romaniuk avatar Sep 03 '24 15:09 ihor-romaniuk

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

farhaanbukhsh avatar Sep 05 '24 13:09 farhaanbukhsh

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

edx-pipeline-bot avatar Sep 09 '24 10:09 edx-pipeline-bot

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

edx-pipeline-bot avatar Sep 09 '24 15:09 edx-pipeline-bot