Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-4296

Review appstore development documentation changes

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      There are known gaps in the current development documentation, specifically in Step 11: Local Email Setup. The email functionality is inconsistent it works in some environments and fails in others, sometimes without clear error messages.

      This intermittent behavior is not due to changes in Django itself. The send_mail() function used for email sending remains unchanged between Django 2.2 and 4.2, so the underlying framework should function consistently after the upgrade. The inconsistent behavior is likely related to incomplete or environment-specific setup steps that are currently missing or unclear in the documentation.

      To ensure reliability the development documentation must be updated and validated so that email functionality can be set up and tested reliably across different environments.

        Attachments

          Issue Links

            Activity

            sjagarap saideepthi jagarapu (Inactive) created issue -
            sjagarap saideepthi jagarapu (Inactive) made changes -
            Field Original Value New Value
            Epic Link IGBF-3014 [ 21526 ]
            sjagarap saideepthi jagarapu (Inactive) made changes -
            Link This issue clones IGBF-4275 [ IGBF-4275 ]
            sjagarap saideepthi jagarapu (Inactive) made changes -
            Description In previous issues (see linked tickets) [~sjagarap] re-discovered that the current configuration of App Store development environment can't run as-is and needs to be updated.

            To start, let's identity the latest, most robust version of python 3 that can run App Store, with whatever updated dependencies may be required.

            To complete this ticket:

            * Update the Developer's Guide to show all new development environment configurations that developers need to know about in order to start working on App Store.
            * Update code as needed to achieve same
            * Focus on the development environment only (we will address the production environment in another ticket)
            * Demonstrate that with the required changes, all functionality works as expected (except for the pending apps endpoint, which is fixed as part of a linked ticket)
            There are known gaps in the current development documentation, specifically in Step 11: Local Email Setup. The email functionality is inconsistent it works in some environments and fails in others, sometimes without clear error messages.

            This intermittent behavior is not due to changes in Django itself. The send_mail() function used for email sending remains unchanged between Django 2.2 and 4.2, so the underlying framework should function consistently after the upgrade. The inconsistent behavior is likely related to incomplete or environment-specific setup steps that are currently missing or unclear in the documentation.

            To ensure reliability the development documentation must be updated and validated so that email functionality can be set up and tested reliably across different environments.
            sjagarap saideepthi jagarapu (Inactive) made changes -
            Assignee Ann Loraine [ aloraine ] saideepthi jagarapu [ sjagarap ]
            sjagarap saideepthi jagarapu (Inactive) made changes -
            Link This issue relates to IGBF-4275 [ IGBF-4275 ]
            sjagarap saideepthi jagarapu (Inactive) made changes -
            Link This issue clones IGBF-4275 [ IGBF-4275 ]
            ann.loraine Ann Loraine made changes -
            Sprint Fall 1, Summer 5, Summer 6 [ 83, 222, 223 ] Fall 1, Summer 5, Summer 6, Fall 2 [ 83, 222, 223, 225 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Sprint Fall 1, Summer 5, Summer 6, Fall 2 [ 83, 222, 223, 225 ] Fall 1, Summer 5, Summer 6, Fall 2, Fall 3 [ 83, 222, 223, 225, 226 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            sjagarap saideepthi jagarapu (Inactive) made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            sjagarap saideepthi jagarapu (Inactive) made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            sjagarap saideepthi jagarapu (Inactive) made changes -
            Assignee saideepthi jagarapu [ sjagarap ]
            ann.loraine Ann Loraine made changes -
            Sprint Fall 1, Summer 5, Summer 6, Fall 2, Fall 3 [ 83, 222, 223, 225, 226 ] Fall 1, Summer 5, Summer 6, Fall 2, Fall 3, Fall 4 [ 83, 222, 223, 225, 226, 227 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Sprint Fall 1, Summer 5, Summer 6, Fall 2, Fall 3, Fall 4 [ 83, 222, 223, 225, 226, 227 ] Fall 1, Summer 5, Summer 6, Fall 2, Fall 3, Fall 4, Fall 5 [ 83, 222, 223, 225, 226, 227, 228 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            nfreese Nowlan Freese made changes -
            Sprint Fall 1, Summer 5, Summer 6, Fall 2, Fall 3, Fall 4, Fall 5 [ 83, 222, 223, 225, 226, 227, 228 ] Fall 1, Summer 5, Summer 6, Fall 2, Fall 3, Fall 4, Fall 5, Fall 6 [ 83, 222, 223, 225, 226, 227, 228, 229 ]
            nfreese Nowlan Freese made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Sprint Fall 1, Summer 5, Summer 6, Fall 2, Fall 3, Fall 4, Fall 5, Fall 6 [ 83, 222, 223, 225, 226, 227, 228, 229 ] Fall 1, Summer 5, Summer 6, Fall 2, Fall 3, Fall 4, Fall 5, Fall 6, Fall 7 [ 83, 222, 223, 225, 226, 227, 228, 229, 230 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            ann.loraine Ann Loraine made changes -
            Sprint Fall 1, Summer 5, Summer 6, Fall 2, Fall 3, Fall 4, Fall 5, Fall 6, Fall 7 [ 83, 222, 223, 225, 226, 227, 228, 229, 230 ] Fall 1, Summer 5, Summer 6, Fall 2, Fall 3, Fall 4, Fall 5, Fall 6, Fall 7, Fall 8 [ 83, 222, 223, 225, 226, 227, 228, 229, 230, 231 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status First Level Review in Progress [ 10301 ] To-Do [ 10305 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ] saideepthi jagarapu [ sjagarap ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee saideepthi jagarapu [ sjagarap ] Paige Kulzer [ pkulzer ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ] saideepthi jagarapu [ sjagarap ]

              People

              • Assignee:
                sjagarap saideepthi jagarapu (Inactive)
                Reporter:
                sjagarap saideepthi jagarapu (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: