docs: adding custom fields documentation step by step#1595
docs: adding custom fields documentation step by step#1595efortish wants to merge 1 commit intoopenedx:masterfrom
Conversation
|
Thanks for the pull request, @efortish! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1595 +/- ##
=======================================
Coverage 87.57% 87.57%
=======================================
Files 125 125
Lines 2309 2309
Branches 644 644
=======================================
Hits 2022 2022
Misses 278 278
Partials 9 9 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Hi @openedx/2u-infinity! Could someone please review / merge this for us? |
|
hi @mphilbrick211 ! The Infinity team is no longer at 2U, the new contractor team has been onboarded but I think similarly to the new team that replaced Phoenix, this new Auth team will not be maintainers of this application. |
arbrandes
left a comment
There was a problem hiding this comment.
I feel like this would have a better home at docs.openedx.org, because it would be easier to find. @sarina, what do you think?
In any case, at the very least the links to edx.readthedocs.io in here should be changed to point to docs.openedx.org.
Finally, @efortish, have you tested that the procedures outlined here actually work?
|
@arbrandes this is a pretty common question, so putting it as a Site Operators how-to on docs.openedx.org would make sense to me. @efortish - remember to always use "Open edX" as an adjective ("the Open edX platform" for example) |
|
Hey @efortish ! It would be great to have these docs back. As Adolfo and Sarina mentioned, docs.openedx.org would be the right place for them. There's currently a version of these docs for the legacy page: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/customize_registration_page.html . I think what we need is someone to replace that document with the up-to-date docs from this PR. Would you be able to take that on, or do you know someone who might? For reference, I believe this is the only outstanding item blocking the removal of the legacy authn pages: |
Restore "Adding Custom Fields to Registration" How-To Guide
Context
This PR restores the documentation guide for adding custom fields to the registration page in the Authn MFE. This guide was previously removed from the repository, but there is no clear trace of when or why it was deleted from the codebase.
The original file is: https://github.com/openedx/frontend-app-authn/blob/63d16364fc2aa6538dd876bd3f6fd5612a20d605/docs/how_tos/adding_custom_fields_to_the_registration.rst#b-add-fields-that-do-not-exist-in-the-user-profile-model
Problem
The documentation for extending registration fields is currently missing from the repository, making it difficult for operators to:
REGISTRATION_EXTRA_FIELDSproperlyThis documentation is essential for organizations that need to collect additional user information during registration beyond the standard fields (email, username, password, name).
Documentation Location
The restored documentation is located at:
docs/how_tos/adding_custom_fields_to_the_registration.rstKey Topics Covered
Testing