AdobeDocs / commerce-php

Source of the Commerce PHP Extensions guide
https://developer.adobe.com/commerce/php/
Other
9 stars 140 forks source link

Missing events #171

Open a-caruso opened 1 year ago

a-caruso commented 1 year ago

Is there an existing issue for this?

What's missing?

In the List of events at page https://developer.adobe.com/commerce/php/development/components/events-and-observers/event-list/ only events whose names start with a,b,c are listed, others are missing

jeff-matthews commented 1 year ago

Hi @a-caruso,

As far as I know, there are lots of events and we don't have a good way to automate documenting them from code. @goivvy graciously took the time to document a subset of events for the community, but it's not comprehensive.

It might be a good idea to add a note to the top of the page clarifying that the list is not exhasutive.

goivvy commented 1 year ago

@jeff-matthews Initial discussion was to split it in several pages, I believe I have all of them but the manager only published the first page.

jeff-matthews commented 1 year ago

@goivvy, thanks for reminding me. I also went back and looked at your original PR before we migrated from devdocs.magento.com.

https://github.com/magento/devdocs/pull/9098

I'm not sure if splitting between multiple pages makes sense anymore. In fact, I think it would be a better user experience to be able to search for all events on a single page. What do you think @goivvy?

goivvy commented 1 year ago

@jeff-matthews Yes, I agree.

jeff-matthews commented 1 year ago

@goivvy, if you have the remaining events, please feel free to create a PR and add them to the existing page.

goivvy commented 1 year ago

@jeff-matthews OK, I'll work on it.

naomirobichaud commented 1 year ago

Found this thread when I was looking at improvements to make events information more human readable. Thank you @goivvy for your contribution, I reference the list often. Would be amazing to enhance the coverage of this list