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

docs: Update student profile report columns #689

Merged
merged 2 commits into from
Jan 8, 2025

Conversation

bmtcril
Copy link
Contributor

@bmtcril bmtcril commented Dec 16, 2024

Per #647 I'm attempting to clarify the columns listed in this doc a bit more and correct a couple of points that I believe are currently wrong.

@bmtcril bmtcril requested review from jswope00 and sarina December 16, 2024 21:26
@bmtcril
Copy link
Contributor Author

bmtcril commented Dec 16, 2024

@jswope00 I'm pinging you on this one if you have time, since you may have context I don't about some of the details. No worries if you don't have time, though!

@jswope00
Copy link
Contributor

This exceeds my understanding of this report. E.g. I wasn't aware of how the verification_status column was enabled. I had actually just deleted that column during some cleanup I was doing today that involved this doc. But I'll defer to your more accurate explanation.

Copy link
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

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

@bmtcril - you wrote in the other ticket:

I think that the text:

" The descriptions of columns in the following table apply to edx.org. Required or optional fields shown to learners during registration and available for editing in Account Settings might vary for Open edX sites."

Only shows up on the edx.org documentation, which is the opposite of what I'd expect based on the tag, but you can see it here:

https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/student_progress/course_student.html#columns-in-the-student-profile-report

but not here:

https://docs.openedx.org/en/latest/educators/references/data/student_profile_report.html


Should we just remove the "Open edX" directive and have all the text there?

@sarina
Copy link
Contributor

sarina commented Jan 3, 2025

@bmtcril bumping this in your inbox - I have a question here, otherwise this is good to merge

@bmtcril
Copy link
Contributor Author

bmtcril commented Jan 8, 2025

@sarina I've clarified the messaging around configuration of columns and removed the only block. I'll merge if it passes tests and looks correct on rtd.

@bmtcril bmtcril merged commit 77167b3 into main Jan 8, 2025
2 checks passed
@bmtcril bmtcril deleted the bmtcril/learner_report_cols branch January 8, 2025 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants