search

magento / devdocs

[Deprecated] Magento Developer Documentation
Open Software License 3.0
674 stars 1.76k forks source link

Feedback on page: /guides/v2.1/javascript-dev-guide/widgets/widget_modal.html #2014

Closed korostii closed 5 years ago

korostii commented 6 years ago

This issue is a:

Description:

The documentation page corresponding to the modal widget seems to omit the fact that the clickableOverlay parameter isn't working as expected in any of the released versions and will only be fixed in the future 2.2.5 version.

Steps to reproduce

  1. Observe https://devdocs.magento.com/guides/v2.1/javascript-dev-guide/widgets/widget_modal.html
  2. Observe https://github.com/magento/magento2/issues/7399
  3. Note that the devdocs page has no reference to that issue nor any mention of anything of the sort.

Expected result:

I would expect the page to contain a mention of that issue, or a reference to it, or a comment section where a community developer could post such a notice for other fellow developers to see.

Possible solutions:

a) add a short mention of that issue to the corresponding documentation issue b) add a reference to the GitHub issue https://github.com/magento/magento2/issues/7399 c) create a comment section where a community developer could post such a notice for other fellow developers to see.

bdenham commented 6 years ago

Hey @korostii, good catch on this. Would you be willing to submit a pull request with the updates you're recommending?

If so, here are some basic instructions on how to contribute to devdocs on our DevDocs Contributions page.

If not, let me know and I'll submit a PR for you.

korostii commented 6 years ago

Hi @bdenham, thanks for the timely response.

I am pretty sure there are Magento's internal policies or legalese restrictions for acknowledging issues but I don't know the specifics. For reference, there is a lengthy discussion on that topic in #1268 (long story short, was requesting a similar edit on a different page and got turned down).

That's one of the reasons why I am a little hesitant to submit any significant changes (or even invest time and effort into them, at all). Don't get me wrong, I would be very glad if you could do such an edit, by all means, feel free to do so as you like.

Just please make sure it's okay to do so, I wouldn't want to get you in trouble =) Keep up the good work & have a nice day!

bdenham commented 6 years ago

@korostii, thanks for the additional info! Interesting. I'll research this issue more to get a better understanding. Thanks, again.

dshevtsov commented 5 years ago

@korostii, according to magento/magento2#7399 the issue has been fixed. If you still observe any documentation issues in 2.2 or 2.3, please let us know.

Note: This issue/pull request applies to 2.1 only. We are no longer accepting pull requests for 2.1 DevDoc updates, because this version reached end of life (EOL) on June 2019. Magento no longer applies security patches, quality fixes, or documentation updates to 2.1.