openedx / docs.openedx.org

[BETA] A new home for learning about Open edX
https://docs.openedx.org
Other
7 stars 57 forks source link

Add Unmaintained warning to Ecomm Docs #525

Closed sarina closed 1 month ago

sarina commented 5 months ago

The README on https://github.com/openedx/ecommerce indicates it is deprecated, but no docs do, leading to end-user confusion.

This ticket is to add DEPR warnings to ecommerce documentation, since most people go to the docs rather than the repos.

Note that in the TOC meeting notes from June 2024 they clearly say that the e-commerce service is deprecated.

Ryan reports:

This documentation was where I went first to find info about ecommerce: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/ecommerce/index.html

Then based on the Tutor distribution documentation:

Those were probably the three main information sources that led me to believe the ecommerce plugin was still viable.

sarina commented 5 months ago

cc @RyanRad-BSG as reporter of this issue

MaferMazu commented 4 months ago

The ecommerce service is still viable, but its current status is under-maintained and is in the process of being deprecated. Kyle updated the info of the openedx/ecommerce repository with that info. Should we try adding via a PR that warns in Edly, Overhangio, and edX doc repositories?

cc @sarina @RyanRad-BSG

sarina commented 4 months ago

I changed the title to "Unmaintained". Most end-users are reading the documentation, not the repo's readme. Warnings like that on the ecommerce repo should go in any place that people may be looking for information on ecommerce.

sarina commented 4 months ago

in the TOC meeting notes from June 2024 it clearly says the e-commerce service is deprecated.

sarina commented 4 months ago

I made PRs to the docs site and the Tutor ecomm plugin; I reached out to edly about updating the tutor plugin page at https://edly.io/tutor/ecommerce-plugin/

regisb commented 1 month ago

Sorry about my delayed response. The ecommerce plugin page has been updated: https://edly.io/tutor/ecommerce-plugin/

sarina commented 1 month ago

Thanks @regisb !