Skip to content

Update docs: Adding Custom Fields to the Registration Page#1429

Closed
Apgomeznext wants to merge 8 commits intoopenedx:mainfrom
Apgomeznext:Apgomeznext/adding-custom-fields-docs
Closed

Update docs: Adding Custom Fields to the Registration Page#1429
Apgomeznext wants to merge 8 commits intoopenedx:mainfrom
Apgomeznext:Apgomeznext/adding-custom-fields-docs

Conversation

@Apgomeznext
Copy link
Copy Markdown
Contributor

PR: openedx/frontend-app-authn#1595 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:

Understand how to add custom fields to the registration page Configure REGISTRATION_EXTRA_FIELDS properly
Extend the UserProfile model with custom fields
Integrate custom forms with the Authn MFE
This 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.rst

Key Topics Covered
Introduction to custom registration fields
Difference between required and optional fields
Step-by-step configuration for existing fields
Advanced guide for custom UserProfile field extensions Backend and frontend integration requirements
Configuration examples for different deployment methods Testing
I followed up the instructions and everything is working as expected

PR: openedx/frontend-app-authn#1595
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:

Understand how to add custom fields to the registration page
Configure REGISTRATION_EXTRA_FIELDS properly
Extend the UserProfile model with custom fields
Integrate custom forms with the Authn MFE
This 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.rst

Key Topics Covered
Introduction to custom registration fields
Difference between required and optional fields
Step-by-step configuration for existing fields
Advanced guide for custom UserProfile field extensions
Backend and frontend integration requirements
Configuration examples for different deployment methods
Testing
I followed up the instructions and everything is working as expected
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @Apgomeznext!

This repository is currently maintained by @openedx/wg-maintenance-docs.openedx.org.

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

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


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

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

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 15, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Apr 15, 2026
@Apgomeznext Apgomeznext requested a review from efortish April 15, 2026 21:55
@efortish
Copy link
Copy Markdown

LGTM thank you so much @Apgomeznext

Copy link
Copy Markdown
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.

I'm having trouble following this doc. Please ping me when the docs build passes so I can review it more thoroughly as a rendered page. Thanks!

from the form.
Method 1: Redefine constants using Django admin and `Site configurations` API. (recommended)
---------------------------------------------------------------------------------------------
#. Go to `Site configurations` in admin: {{LMS}}/admin/site_configuration/siteconfiguration/
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In RST, code blocks use two backticks. And paths should also be in code blocks.

Suggested change
#. Go to `Site configurations` in admin: {{LMS}}/admin/site_configuration/siteconfiguration/
#. Go to ``Site configurations`` in admin: ``{{LMS}}/admin/site_configuration/siteconfiguration/``

@Apgomeznext
Copy link
Copy Markdown
Contributor Author

@sarina @efortish, this PR is causing a lot of trouble, and we need to work on the content, so I will close the PR for the moment and reopen it when we have everything ready to stop creating noise in the repository, if you agree.

@sarina
Copy link
Copy Markdown
Contributor

sarina commented May 7, 2026

@Apgomeznext this is useful content, I pushed a commit that should unbreak the build for a better review

@sarina
Copy link
Copy Markdown
Contributor

sarina commented May 7, 2026

OK, the build rendered but I'm going to push another commit shortly that will fix a lot of the visual rendering issues. I do have some technical questions that I can work with @efortish on

@efortish
Copy link
Copy Markdown

efortish commented May 7, 2026

Hello @sarina

Sure, let me know how can we enhance the instructions and I'll work on that

@sarina
Copy link
Copy Markdown
Contributor

sarina commented May 7, 2026

Closing in favor of #1451

@sarina sarina closed this May 7, 2026
@github-project-automation github-project-automation Bot moved this from Waiting on Author to Done in Contributions May 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants