Skip to content

Commit 3495f2a

Browse files
committed
MC-4181: Organize Existing Topics
Rename topics, files, and reorganized TOC for devdocs inclusion
1 parent 1fc3f75 commit 3495f2a

40 files changed

+552
-2180
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@
44
**.d.js
55
/dev/tests/acceptance/vendor
66
static-error-log.xml
7-
.DS_Store
7+
.DS_Store
8+
.vscode

CONTRIBUTING.md

Lines changed: 5 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,5 @@
11
# Contributing to Magento 2 code
2-
<!-- {% comment %} -->
3-
## Navigation
42

5-
1. [Introduction]
6-
2. [Installation guide]
7-
3. **Contribution guide**
8-
1. [Overview](#overview)
9-
1. [Contribution requirements](#contribution-requirements)
10-
1. [Contribution process](#contribution-process)
11-
1. [Code of Conduct](#code-of-conduct)
12-
4. [Developer documentation]
13-
5. [Roadmap and known issues]
14-
6. [How to create custom PageBuilder content type container]
15-
16-
[Introduction]: introduction.md
17-
[Contribution guide]: CONTRIBUTING.md
18-
[Installation guide]: install.md
19-
[Developer documentation]: developer-documentation.md
20-
[Architecture overview]: architecture-overview.md
21-
[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
22-
[Third-party content type migration]: new-content-type-example.md
23-
[Iconography]: iconography.md
24-
[Add image uploader to content type]: image-uploader.md
25-
[Module integration]: module-integration.md
26-
[Additional data configuration]: custom-configuration.md
27-
[Content type configuration]: content-type-configuration.md
28-
[How to add a new content type]: how-to-add-new-content-type.md
29-
[Events]: events.md
30-
[Bindings]: bindings.md
31-
[Master format]: master-format.md
32-
[Visual select]: visual-select.md
33-
[Reuse product conditions in content types]: product-conditions.md
34-
[Store component master format as widget directive]: widget-directive.md
35-
[Use the block chooser UI component]: block-chooser-component.md
36-
[Use the inline text editing component]: inline-editing-component.md
37-
[Render a backend content type preview]: content-type-preview.md
38-
[Custom Toolbar]: toolbar.md
39-
[Full width page layouts]: full-width-page-layouts.md
40-
[Add image uploader to content type]: image-uploader.md
41-
[Roadmap and Known Issues]: roadmap.md
42-
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
43-
<!-- {% endcomment %} -->
443
## Overview
454

465
Contributions to the Magento 2 codebase are done using the fork & pull model.
@@ -50,18 +9,17 @@ Contributions can take the form of new components/features, changes to existing
509

5110
The Magento 2 development team will review all issues and contributions submitted by the community of developers in the first in, first out order. During the review we might require clarifications from the contributor. If there is no response from the contributor for two weeks, the issue is closed.
5211

53-
5412
## Contribution requirements
5513

5614
1. Contributions must adhere to [Magento coding standards](http://devdocs.magento.com/guides/v2.0/coding-standards/bk-coding-standards.html).
5715
2. Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances of a pull request to be merged quickly and without additional clarification requests.
5816
3. Commits must be accompanied by meaningful commit messages.
5917
4. PRs which include bug fixing, must be accompanied with step-by-step description of how to reproduce the bug.
60-
3. PRs which include new logic or new features must be submitted along with:
61-
* Unit/integration test coverage where applicable.
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.
18+
5. PRs which include new logic or new features must be submitted along with:
19+
* Unit/integration test coverage where applicable.
20+
* Updated documentation in the `docs` directory at the root level.
21+
6. 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.
22+
7. All automated tests are passed successfully locally. After PR submitted Magento team will run builds on continuous integration environment.
6523

6624
## Contribution process
6725

README.md

Lines changed: 49 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,72 +9,77 @@ The PageBuilder Early Access Program (EAP) gives partners the following perks:
99
* Explore PageBuilder extension points to build custom modules and integrations for 3rd party services, such as Facebook, Instagram, etc.
1010
* Try out PageBuilder customization options and extend its functionality beyond its default features.
1111
* Preview PageBuilder to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
12-
12+
1313
**Note:**
1414
*This program should not be used to design and launch a production website using early code.*
1515

1616
## Installation
1717

1818
We offer two methods for installing PageBuilder:
1919

20-
* As a [Composer package] - use this option if you do not plan to contribute to the PageBuilder code repository
21-
* Using the [GitHub repository] - use this option to install PageBuilder from the GitHub repository and contribute to the code
20+
* As a [Composer package] - use this option if you do not plan to contribute to the PageBuilder code repository.
21+
* Using the [GitHub repository] - use this option to install PageBuilder from the GitHub repository and contribute to the code.
22+
23+
[Composer package]: docs/install-pagebuilder.md#composer-installation
24+
[GitHub repository]: docs/install-pagebuilder.md#github-installation
2225

23-
[Composer package]: docs/install.md#composer-installation
24-
[GitHub repository]: docs/install.md#github-installation
26+
<!-- {% comment %} -->
2527

2628
## Developer documentation
2729

28-
This project repository contains PageBuilder developer documentation on the following topics:
29-
30-
1. [Architecture overview]
31-
1. [BlueFoot to PageBuilder data migration]
32-
1. [Third-party content type migration]
33-
1. [Iconography]
34-
1. [Module integration]
35-
1. [Additional data configuration]
36-
1. [Content type configuration]
37-
1. [How to add a new content type]
38-
1. [Events]
39-
1. [Bindings]
40-
1. [Master format]
41-
1. [Visual select]
42-
1. [Custom Toolbar]
43-
44-
[Architecture overview]: docs/architecture-overview.md
45-
[BlueFoot to PageBuilder data migration]: docs/bluefoot-data-migration.md
46-
[Third-party content type migration]: docs/new-content-type-example.md
47-
[Iconography]: docs/iconography.md
48-
[Module integration]: docs/module-integration.md
49-
[Additional data configuration]: docs/custom-configuration.md
50-
[Content type configuration]: docs/content-type-configuration.md
51-
[How to add a new content type]: docs/how-to-add-new-content-type.md
52-
[Events]: docs/events.md
53-
[Bindings]: docs/bindings.md
54-
[Master format]: docs/master-format.md
55-
[Visual select]: docs/visual-select.md
56-
[Custom Toolbar]: docs/toolbar.md
30+
### Getting Started
5731

58-
## Contribute to PageBuilder
32+
1. [Introduction](docs/getting-started/introduction.md)
33+
2. [Install Page Builder](docs/getting-started/install-pagebuilder.md)
34+
3. [Activate Page Builder](docs/getting-started/activate-pagebuilder.md)
35+
4. [Integrate Page Builder](docs/getting-started/integrate-pagebuilder.md)
36+
37+
### Customizations
38+
39+
* [Block chooser](docs/customizations/block-chooser.md)
40+
* [Full-width page layouts](docs/customizations/full-width-page-layouts.md)
41+
* [Responsive layouts](docs/customizations/responsive-layouts.md)
42+
* [Custom logic](docs/customizations/custom-logic.md)
43+
* [Visual selects](docs/customizations/visual-selects.md)
44+
* [Data configuration](docs/customizations/data-configuration.md)
45+
* [Product conditions](docs/customizations/product-conditions.md)
46+
* [Server-side rendered previews](docs/customizations/server-side-rendered-previews.md)
47+
48+
### How Tos
49+
50+
* [How to add a new content type](docs/how-to/how-to-add-new-content-type.md)
51+
* [How to add an image uploader](docs/how-to/how-to-add-image-uploader.md)
52+
* [How to add inline text editing](docs/how-to/how-to-add-inline-text-editing.md)
53+
* [How to add a custom toolbar](docs/how-to/how-to-add-custom-toolbar.md)
54+
* [How to create a custom container](docs/how-to/how-to-create-custom-container.md)
55+
* [How to store a component master format as a widget-directive](docs/how-to/how-to-store-master-format-as-widget-directive.md)
5956

60-
We appreciate any and all contributions to PageBuilder.
61-
A good place to start is by looking at our [features roadmap] and list of [known issues].
57+
### Reference
6258

63-
If you are interested in contributing to this repository, please see our [Contribution Guide].
59+
* [Architecture](docs/reference/architecture.md)
60+
* [Events](docs/reference/events.md)
61+
* [Bindings](docs/reference/bindings.md)
62+
* [Content type configuration](docs/reference/content-type-configuration.md)
63+
* [Master format](docs/reference/master-format.md)
64+
65+
### Migration
66+
67+
* [Bluefoot data migration](docs/migration/bluefoot-data-migration.md)
68+
* [Third-party content type migration](docs/migration/third-party-content-type-migration.md)
69+
70+
<!-- {% endcomment %} -->
71+
72+
## Contribute to PageBuilder
73+
74+
We appreciate any and all contributions to PageBuilder. If you are interested in contributing to this repository, please see our [Contribution Guide].
6475

6576
[Contribution Guide]: CONTRIBUTING.md
66-
[features roadmap]: docs/roadmap.md#planned-features-and-functionality
67-
[known issues]: docs/roadmap.md#known-issues
6877

6978
## PageBuilder updates from the Magento core team
7079

7180
The PageBuilder team updates the code every 2 weeks.
7281
**These changes may introduce breaking changes.**
7382

74-
To help you prepare for these changes, we are publishing a [roadmap] of features and issues that we are going to work on in the following months.
75-
76-
[roadmap]: docs/roadmap.md
77-
7883
## Provide feedback
7984

8085
We want to hear what you think of PageBuilder!

docs/CONTRIBUTING.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

0 commit comments

Comments
 (0)