search

openedx / public-engineering

General public issue repository for the Open edX engineering community
3 stars 1 forks source link

[DEPR]: Shifting edX-app-ios to openedx-unsupported + Updated documentation #260

Open marcotuts opened 9 months ago

marcotuts commented 9 months ago

(related: edx-app-android deprecation)

Proposal Date

2023-10-02

Target Ticket Acceptance Date

2024-02-01

Earliest Open edX Named Release Without This Functionality

Redwood - 2024-04

Rationale

This ticket is a result of OEP-64, where we ratified the adoption of new code bases for both the iOS and Android mobile applications.This DEPR ticket kicks off a conversation with all involved parties to ensure all mobile app repository documentation/readme details make clear the support level for this repository.

After this change, we hope new open edx community members will be encouraged to contribute to the new mobile repositories.

Removal

This codebase is shifting to no longer be the primary Open edX iOS mobile app, starting with the Redwood named release is our target. The organization of this repo will shift from openedx to openedx-unsupported when this ticket is resolved.

Replacement

The new iOS repositoriy is located here: https://github.com/openedx/openedx-app-ios

Deprecation

1 - Updated documentation / readme details to be coordinated with @openedx/edx-mobile-admin regarding this shift 2 - Eventual github org shift (presumably to be handled by Axim github admins) for this repo to the openedx-unsupported github organizaiton.

Migration

We will be looking at migration path for interested community members via - https://github.com/openedx/openedx-app-ios/issues/99

Additional Info

Please feel free to ask questions about this here or in #wg-product-mobile on slack! 

### Tasks
- [x] Update edx-app-ios Readme to reference OEP-64 / new openedx-repository
- [ ] https://github.com/openedx/axim-engineering/issues/1114
- [ ] Update build readme details to reflect git commands for new openedx-unsupported organization
- [ ] Update project About section (Currently links to out of date document)
- [x] Update mobile-announcements Slack channel name / topic / description to reflect "edx-" focus
- [ ] Review "Deprecated" section of DEPR docs to update API queries / etc as needed
- [ ] Update docs.edx.org - https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/mobile.html and other mobiel references
marcotuts commented 8 months ago

@moiz994 - I will try to take a pass next at identifying some tasks for this ticket regarding this DEPR ticket, and once we feel like we have the right list of things we can echo this in the Android ticket as well after you've had time to review

dianakhuang commented 5 months ago

@marcotuts I moved this back into Proposed so that we could get a more official deprecation announcement to let people know this is happening. Could you follow the steps listed in the deprecation OEP? https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0021-proc-deprecation.html#communicated

marcotuts commented 4 months ago

Thanks for flagging @dianakhuang - I will make sure to review the process in more detail, I'm not sure what happened last time I read this document, but I cannot find the discourse post. fixing asap.

marcotuts commented 4 months ago

Discourse post announcing deprecation: https://discuss.openedx.org/t/deprecation-removal-edx-mobile-ios-edx-mobile-android-https-github-com-openedx-edx-app-ios-issues-1804-1804/12430