Skip to content

feat: add new help section in course teams page #2372

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
+34 −0
Draft

feat: add new help section in course teams page #2372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/course-team/course-team-sidebar/CourseTeamSideBar.test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ describe('<CourseTeamSidebar />', () => {
expect(getByText(messages.sidebarAbout_1.defaultMessage)).toBeInTheDocument();
expect(getByText(messages.sidebarAbout_2.defaultMessage)).toBeInTheDocument();
expect(getByText(messages.sidebarAbout_3.defaultMessage)).toBeInTheDocument();
expect(getByText(messages.helpInfoSidebarTitle.defaultMessage)).toBeInTheDocument();
expect(getByText(/to add, remove, or update user access in bulk\./i)).toBeInTheDocument();
});

it('render CourseTeamSidebar when isOwnershipHint is true', () => {
Expand Down
20 changes: 20 additions & 0 deletions src/course-team/course-team-sidebar/CourseTeamSidebar.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,26 @@ const CourseTeamSideBar = ({ courseId, isOwnershipHint, isShowInitialSidebar })
<p className="help-sidebar-about-descriptions">
{intl.formatMessage(messages.sidebarAbout_3)}
</p>
<p className="help-sidebar-other-title">
<svg xmlns="http://www.w3.org/2000/svg" width="18" height="18" fill="currentColor" className="mr-2" viewBox="0 0 18 18">
<path d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14m0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16" />
<path d="m8.93 6.588-2.29.287-.082.38.45.083c.294.07.352.176.288.469l-.738 3.468c-.194.897.105 1.319.808 1.319.545 0 1.178-.252 1.465-.598l.088-.416c-.2.176-.492.246-.686.246-.275 0-.375-.193-.304-.533zM9 4.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0" />
</svg>
Comment on lines +34 to +37
Copy link
Contributor

Choose a reason for hiding this comment

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

can we use paragon icon here?
import { InfoOutline } from '@openedx/paragon/icons';

{intl.formatMessage(messages.helpInfoSidebarTitle)}
</p>
<p className="help-sidebar-about-descriptions">
{intl.formatMessage(messages.helpInfoDescription, {
email_address: (
<a
href={`mailto:${intl.formatMessage(messages.helpInfoMaildropLink)}`}
target="_blank"
rel="noopener noreferrer"
>
{intl.formatMessage(messages.helpInfoMaildropLink)}
Comment on lines +44 to +48
Copy link
Contributor

Choose a reason for hiding this comment

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

We will not be hard coding the email address here, it will be fetched from backend in some variable.
And we don't need to localize this email meaning wrapping it inside intl.formatMessage is not needed for email.

</a>
),
})}
</p>
</HelpSidebar>
{isOwnershipHint && (
<>
Expand Down
12 changes: 12 additions & 0 deletions src/course-team/course-team-sidebar/messages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ const messages = defineMessages({
id: 'course-authoring.course-team.sidebar.ownership.description',
defaultMessage: 'Every course must have an Admin. If you are the Admin and you want to transfer ownership of the course, click {strong} to make another user the Admin, then ask that user to remove you from the Course Team list.',
},
helpInfoSidebarTitle: {
id: 'course-authoring.course-team.sidebar.helpInfoSidebarTitle',
defaultMessage: 'Need help across multiple courses?',
},
helpInfoDescription: {
id: 'course-authoring.course-team.sidebar.helpInfoDescription',
defaultMessage: 'Email {email_address} to add, remove, or update user access in bulk.',
},
helpInfoMaildropLink: {
id: 'course-authoring.course-team.sidebar.helpInfoMaildropLink',
defaultMessage: '[email protected]',
},
addAdminAccess: {
id: 'course-authoring.course-team.sidebar.ownership.addAdminAccess',
defaultMessage: 'Add admin access',
Expand Down