Skip to content

Commit 468425c

Browse files
committed
MC-4181: Organize Existing Topics
Fixed linking issues in events.md and a spelling mistake and updated path to docs directory in Contributing.md
1 parent 78c5ba9 commit 468425c

File tree

2 files changed

+44
-38
lines changed

2 files changed

+44
-38
lines changed

docs/CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,16 @@ The Magento 2 development team will review all issues and contributions submitte
5959
4. PRs which include bug fixing, must be accompanied with step-by-step description of how to reproduce the bug.
6060
3. PRs which include new logic or new features must be submitted along with:
6161
* Unit/integration test coverage where applicable.
62-
* Updated documentation in the module directory `app/code/PageBuilder/docs`.
63-
4. For large features or changes, please [open an issue](https://github.com/magento/magento2/issues) and discuss first. This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
64-
5. All automated tests are passed successfully locally. After PR submitted Magento team will run builds on continuous integration environment.
62+
* Updated documentation in the `docs` directory at the root level.
63+
1. For large features or changes, please [open an issue](https://github.com/magento/magento2/issues) and discuss first. This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
64+
2. All automated tests are passed successfully locally. After PR submitted Magento team will run builds on continuous integration environment.
6565

6666
## Contribution process
6767

6868
If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free). By doing that, you will be able to collaborate with the Magento 2 development team, “fork” the Magento 2 project and be able to easily send “pull requests”.
6969

7070
1. Search current [listed issues](https://github.com/magento/magento2-page-builder/issues) on GitHub (open or closed) and [list of known issues](roadmap.md#Known Issues) on our roadmap for similar proposals of intended contribution before starting work on a new contribution.
71-
2. Please contact us in Slack chanel if you want to work on issue from [list of known issues](roadmap.md#Known Issues).
71+
2. Please contact us in Slack channel if you want to work on issue from [list of known issues](roadmap.md#Known Issues).
7272
2. Review the [Contributor License Agreement](https://magento.com/legaldocuments/mca) if this is your first time contributing.
7373
3. Create and test your work.
7474
4. Fork the Magento 2 repository according to [Fork a repository instructions](http://devdocs.magento.com/guides/v2.0/contributor-guide/contributing.html#fork) and when you are ready to send us a pull request – follow [Create a pull request instructions](http://devdocs.magento.com/guides/v2.0/contributor-guide/contributing.html#pull_request). Instructions written for `https://github.com/magento/magento2` repository, but they also apply to `https://github.com/magento/magento2-page-builder`.

docs/events.md

Lines changed: 40 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -67,41 +67,47 @@ This document contains reference information for events dispatched in Page Build
6767
**Note:**
6868
*We are revising naming conventions for events, naming may change.*
6969

70-
## Events list
71-
72-
* [contentType:createAfter](#contenttypecreateafter)
73-
* [contentType:dropAfter](#contenttypedropafter)
74-
* [contentType:mountAfter](#contenttypemountafter)
75-
* [contentType:renderAfter](#contenttyperenderafter)
76-
* [contentType:removeAfter](#contenttyperemoveafter)
77-
* [contentType:duplicateAfter](#contenttypeduplicateafter)
78-
* [contentType:moveBefore](#contenttypemovebefore)
79-
* [contentType:moveAfter](#contenttypemoveafter)
80-
* [contentType:redrawAfter](#contenttyperedrawafter)
81-
* [column:dragStart](#columdragstart)
82-
* [column:dragStop](#columndragstop)
83-
* [column:initializeAfter](#columninitializeafter)
84-
* [image:{{id}}:assignAfter](#imageidassignafter)
85-
* [image:mountAfter](#imagemountafter)
86-
* [image:uploadAfter](#imageuploadafter)
87-
* [stage:interactionStart](#stageinteractionstart)
88-
* [stage:interactionStop](#stageinteractionstop)
89-
* [stage:{{id}}:toggleFullscreen](#stageidtogglefullscreen)
90-
* [previewData:updateAfter](#previewdataupdateafter)
91-
* [previewSortable:sortstart](#previewsortablesortstart)
92-
* [previewSortable:sortupdate](#previewsortablesortupdate)
93-
* [stage:error](#stageerror)
94-
* [stage:{{id}}:readyAfter](#stageidreadyafter)
95-
* [stage:{{id}}:masterFormatRenderAfter](#stageidmasterformatrenderafter)
96-
* [stage:updateAfter](#stageupdateafter)
97-
* [stage:childFocusStart](#stagechildfocusstart)
98-
* [stage:childFocusStop](#stagechildfocusstop)
99-
* [state](#state)
100-
* [{{config.name}}:{{id}}:updateAfter](#confignameidupdateafter)
101-
* [googleMaps:authFailure](#googlemapsauthFailure)
70+
## Events list {#eventslist}
71+
72+
- [Events](#events)
73+
- [Navigation](#navigation)
74+
- [Events list {#eventslist}](#events-list-eventslist)
75+
- [`contentType:*` events](#contenttype-events)
76+
- [`contentType:createAfter`](#contenttypecreateafter)
77+
- [`contentType:mountAfter`](#contenttypemountafter)
78+
- [`contentType:dropAfter`](#contenttypedropafter)
79+
- [`contentType:mountAfter`](#contenttypemountafter)
80+
- [`contentType:renderAfter`](#contenttyperenderafter)
81+
- [`contentType:removeAfter`](#contenttyperemoveafter)
82+
- [`contentType:duplicateAfter`](#contenttypeduplicateafter)
83+
- [`contentType:moveBefore`](#contenttypemovebefore)
84+
- [`contentType:moveAfter`](#contenttypemoveafter)
85+
- [`contentType:redrawAfter`](#contenttyperedrawafter)
86+
- [Backend](#backend)
87+
- [Frontend](#frontend)
88+
- [`column:dragStart`](#columndragstart)
89+
- [`column:dragStop`](#columndragstop)
90+
- [`column:initializeAfter`](#columninitializeafter)
91+
- [`image:{{id}}:assignAfter`](#imageidassignafter)
92+
- [`image:mountAfter`](#imagemountafter)
93+
- [`image:uploadAfter`](#imageuploadafter)
94+
- [`stage:interactionStart`](#stageinteractionstart)
95+
- [`stage:interactionStop`](#stageinteractionstop)
96+
- [`stage:{{id}}:toggleFullscreen`](#stageidtogglefullscreen)
97+
- [`previewData:updateAfter`](#previewdataupdateafter)
98+
- [`previewSortable:sortstart`](#previewsortablesortstart)
99+
- [`previewSortable:sortupdate`](#previewsortablesortupdate)
100+
- [`stage:error`](#stageerror)
101+
- [`stage:{{id}}:readyAfter`](#stageidreadyafter)
102+
- [`stage:{{id}}:masterFormatRenderAfter`](#stageidmasterformatrenderafter)
103+
- [`stage:updateAfter`](#stageupdateafter)
104+
- [`stage:childFocusStart`](#stagechildfocusstart)
105+
- [`stage:childFocusStop`](#stagechildfocusstop)
106+
- [`state`](#state)
107+
- [`{{config.name}}:{{id}}:updateAfter`](#confignameidupdateafter)
108+
- [`googleMaps:authFailure`](#googlemapsauthfailure)
102109

103110
## `contentType:*` events
104-
105111
All events starting with `contentType:` can also be called for specific content types by prefixing the content types name (`{{name}}:{{event}}`) like the following:
106112
* `text:createAfter`
107113
* `row:mountAfter`
@@ -603,6 +609,6 @@ _none_
603609

604610
[Back to top]
605611

606-
[Back to top]: #events
612+
[Back to top]: #eventslist
607613

608614
<!-- {% endraw %} -->

0 commit comments

Comments
 (0)