Skip to content

Commit 89dfe45

Browse files
author
Igor Melnikov
authored
Merge pull request #63 from magento-obsessive-owls/MAGETWO-91956-add-troubleshooting-guide
[CMS Team 2 - Sprint 8] Add troubleshooting guide
2 parents fc1f1b9 + f5d32fe commit 89dfe45

File tree

2 files changed

+50
-4
lines changed

2 files changed

+50
-4
lines changed
Loading

app/code/Magento/PageBuilder/docs/install.md

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
1. [Composer installation](#composer-installation)
99
1. [GitHub installation](#github-installation)
1010
1. [Activation](#activation)
11+
1. [Troubleshooting](#troubleshooting)
1112
3. [Contribution guide]
1213
4. [Developer documentation]
1314
5. [Roadmap and known issues]
@@ -32,13 +33,22 @@ Use this method if you are testing and evaluating PageBuilder for your Magento s
3233

3334
### Prerequisites
3435

35-
* You submitted us MAGEID and github username and received access to 2.3 alpha and PageBuilder 100.0.0 alpha. If you didn't submit us github username with will send you an email and request it.
36+
* You submitted your MAGEID and github username and received access to 2.3 alpha and PageBuilder 100.0.0 alpha.
37+
If you didn't submit this information, send us an email to request access.
3638

3739
### Installation steps
3840

39-
1. If you have installed 2.3.0 alpha or Page Builder 100.0.0 alpha version installed, run `composer clearcache` before installing again. If you don’t clear the cache, Composer will not download the latest alpha release from the repo. It will instead use your locally cached packages.
41+
1. If you already have 2.3.0 alpha or Page Builder 100.0.0 alpha version installed, run the following command before installing again:
42+
``` sh
43+
composer clearcache
44+
```
45+
If you don’t clear the cache, Composer will not download the latest alpha release from the repo and will use the local, cached packages instead.
4046
2. Navigate to the directory where you want to install Magento and Page Builder.
41-
3. Install 2.3.0 alpha Commerce package, run composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.0-alpha.
47+
3. Install the 2.3.0 alpha Commerce package using the following command:
48+
``` sh
49+
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.0-alpha
50+
```
51+
4252
Enter the access keys for your account (Marketplace / My Profile / Access Keys)
4353
4. Install Page Builder
4454
``` sh
@@ -104,4 +114,40 @@ Follow these steps to activate PageBuilder in the Admin:
104114
2. In the **Stores** tab, select **Configuration** under the Settings group.
105115
3. In the **General** group on the page, select **Content Management**.
106116
4. Under **Advanced Content Tools**, select **Yes** for **Enable Page Builder**.
107-
5. Click **Save Config**
117+
5. Click **Save Config**
118+
119+
## Troubleshooting
120+
121+
### Common access problems
122+
123+
If you are having trouble installing PageBuilder, please verify that the `MAGEID` account you provided for the Early Access Program (EAP) belongs to an active Magento partner account.
124+
125+
**Note:**
126+
*Your company may have multiple Magento accounts, and only one or two may be active.*
127+
*Ask your company to provide you with an active Magento account.*
128+
129+
Log into www.magento.com and see if the **Support** and **Downloads** tabs are available.
130+
131+
![Support and downloads tabs](images/support-downloads-tab.png)
132+
133+
If these tabs do not appear in your Magento account, it is not an active Magento partner account, and
134+
you will not be able to access PageBuilder.
135+
136+
If you provided incorrect `MAGEID` by mistake and have another one that is valid, please resubmit this form:
137+
https://goo.gl/forms/unvuDikl9wydmKt12
138+
139+
### Errors
140+
141+
If you run into any of the following errors:
142+
143+
```
144+
Could not find package magento/project-enterprise-edition with version 2.3.0-alpha.
145+
```
146+
```
147+
Could not find a matching version of package magento/module-page-builder-commerce. Check the package spelling, your version constraint and that the package is available in a stability which matches your minimum-stability (stable).
148+
```
149+
150+
Check your composer keys in the `auth.json` file.
151+
If these keys are correct and you still encounter these errors, please contact [Olena Tkacheva].
152+
153+
[Olena Tkacheva]: https://magentocommeng.slack.com/messages/@UAFV915FB

0 commit comments

Comments
 (0)