ADR for Sysadmin Dashboard deprecation and removal - #24048
Conversation
|
Thanks for the pull request, @pdpinch! I've created OSPR-4570 to keep track of it in JIRA. As a core committer in this repo, you can merge this once the pull request is approved per the core committer reviewer requirements and according to the agreement with your edX Champion. |
openedx-webhooks
added
needs triage
open-source-contribution
There was a problem hiding this comment.
Needs a link to user retirement documentation
There was a problem hiding this comment.
User Retirement developer doc: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/user_retire/
User Retirement user doc: https://support.edx.org/hc/en-us/articles/206915007-How-can-I-delete-my-account-
There was a problem hiding this comment.
Thanks, will add a link to the developer doc.
|
@pdpinch Thank you for your contribution. Please let me know once it is ready for our review. |
openedx-webhooks
added
waiting on author
There was a problem hiding this comment.
Nit: Should mitodl be edx?
There was a problem hiding this comment.
User Retirement developer doc: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/user_retire/
User Retirement user doc: https://support.edx.org/hc/en-us/articles/206915007-How-can-I-delete-my-account-
There was a problem hiding this comment.
Should we create a separate list for features that could be removed/replaced? rather than including it in this list of APIs needed?
There was a problem hiding this comment.
Move this to the list of features to be replaced?
There was a problem hiding this comment.
I'll move it for now, but I still need to check on insights (our general purpose account for insights access is broken on edx.org -- I think we're opening a ticket)
There was a problem hiding this comment.
Curious: Is there a reason CMS user creation needs to be done from a separate sysadmin dashboard? Is this a workflow not supported elsewhere in the platform?
There was a problem hiding this comment.
I have the same question. =)
There's a chicken-or-the-egg UX challenge with the current interfaces. As an admin, I want to provision courses for faculty who have never used the platform before. I can create the course, but I can't give them CMS access unless they have an account. Account creation is only self-service. So I have to go through a mutli-step process of inviting the faculty, waiting for them to complete account creation, and only than can I gave them access to the course in studio. I'd like to do that in a single step.
There was a problem hiding this comment.
It seems the 2 remaining functionalities that are not replaceable by other features in the platform are:
- Creating a CMS account
- Importing a course from git
Curious: Do we need Python APIs for this or would exposing REST APIs be sufficient?
There was a problem hiding this comment.
REST APIs would be preferable, but I assumed that it would be bigger lift. Doesn't a REST API imply a python API?
There was a problem hiding this comment.
I think there actually may be a REST API for import now, but I don't know if it's considered a "public" interface. More importantly, I think it's missing a couple of key features like handling large courses (with lots of static assets) and sufficient error logging to help course authors understand why an import may have failed.
1fb1e8e to
f981b43
Compare
|
@pdpinch Please let me know once it is ready for another look. |
f981b43 to
01b0ee0
Compare
|
jenkins run all |
|
@pdpinch Can we go ahead and merge this ADR? Though there are implementation questions you are still figuring out, the direction specified by the ADR is valid. |
|
jenkins run py38 python |
|
Your PR has finished running tests. The following contexts failed:
|
|
@nasthagiri this is ready to merge. I presume the failing tests are unrelated. |
|
Sounds good. Merging. |
|
@ormsbee, @nasthagiri: thought you might like to know that pdpinch merged this pull request. |
openedx-webhooks
added
merged
and removed
waiting on author
|
@pdpinch 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
|
EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production. |
|
EdX Release Notice: This PR may have caused e2e tests to fail on Stage. If you're a member of the edX org, please visit #e2e-troubleshooting on Slack to help diagnose the cause of these failures. Otherwise, it is the reviewer's responsibility. E2E tests have failed. https://gocd.tools.edx.org/go/tab/pipeline/history/deploy_to_stage |
|
EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production. |
|
EdX Release Notice: This PR has been deployed to the production environment. |
6 participants
Follow up to https://github.com/edx/edx-platform/pull/23697
This ADR captures the plan necessary for deprecating and removing the sysadmin dashboard.
See https://trello.com/c/vkXNSu2X/23-apis-sysadmin-dashboard-conversion-write-adr and https://discuss.openedx.org/t/suggestion-to-deprecate-the-little-used-sysadmin-management-dashboard/953 for further discussion.