Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Unmaintained warning to Ecomm Docs #525

Open
sarina opened this issue Jul 1, 2024 · 5 comments
Open

Add Unmaintained warning to Ecomm Docs #525

sarina opened this issue Jul 1, 2024 · 5 comments
Labels
blocked by other work PR cannot be finished until other work is complete

Comments

@sarina
Copy link
Contributor

sarina commented Jul 1, 2024

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 sarina added the help wanted Ready to be picked up by anyone in the community label Jul 1, 2024
@sarina
Copy link
Contributor Author

sarina commented Jul 1, 2024

cc @RyanRad-BSG as reporter of this issue

@MaferMazu
Copy link

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 sarina changed the title Add Deprecation warning to Ecomm Docs Add Unmaintained warning to Ecomm Docs Jul 9, 2024
@sarina
Copy link
Contributor Author

sarina commented Jul 9, 2024

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
Copy link
Contributor Author

sarina commented Jul 12, 2024

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

@sarina
Copy link
Contributor Author

sarina commented Jul 12, 2024

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/

@sarina sarina added blocked by other work PR cannot be finished until other work is complete and removed help wanted Ready to be picked up by anyone in the community labels Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked by other work PR cannot be finished until other work is complete
Projects
Status: In Progress - tCRIL
Development

No branches or pull requests

2 participants