Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit b343acd

Browse files
authored
Merge branch 'master' into em_prex-relnotes320
2 parents dc90ff7 + ab94a14 commit b343acd

File tree

58 files changed

+969
-113
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+969
-113
lines changed

.github/ISSUE_TEMPLATE/NEW_FEATURE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,3 @@ Issues that do not comply with our Code of Conduct or do not contain enough info
3636
3737
Feel free to remove this section before creating this issue.
3838
-->
39-

.github/workflows/linter.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@ on:
1919
branches:
2020
- master
2121
- 2.*-develop
22-
paths-ignore:
23-
- '**.md'
24-
- '**.html'
25-
- '**.xml'
2622

2723
###############
2824
# Set the Job #
@@ -54,4 +50,4 @@ jobs:
5450
VALIDATE_ALL_CODEBASE: false
5551
DEFAULT_BRANCH: master
5652
VALIDATE_HTML: false
57-
VALIDATE_MARKDOWN: false
53+
MARKDOWN_CONFIG_FILE: .markdownlint.json

_checks/html_check_hook.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
if url_ignore
3434
url_ignore.push(jekyll_excludes_as_regex).flatten!.uniq!
3535
else
36-
checks_config['html-proofer'].merge!(url_ignore: jekyll_excludes_as_regex)
36+
checks_config['html-proofer'][:url_ignore] = jekyll_excludes_as_regex
3737
end
3838

3939
# Read configuration options for html-proofer

src/_data/toc/how-do-i.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,6 @@ pages:
5555

5656
- label: Customize the list of shipping methods
5757
url: /howdoi/checkout/checkout_shipping_methods.html
58+
59+
- label: Customize Magento Admin design
60+
url: /howdoi/admin/customize_admin.html
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
### Apply file system permissions and ownership {#rc1-samp-ownership}
2+
3+
As part of the sample data upgrade process, you must apply current file system permission and ownership as discussed in the following sections.
4+
Failure to do so will cause your upgrade to fail.
5+
6+
For more information about file system ownership and permissions, see [Overview of ownership and permissions].
7+
8+
#### One-user ownership and permissions
9+
10+
If you run the Magento application as one user (which is typical of shared hosting environments), change file system permissions and ownership as follows:
11+
12+
```bash
13+
cd <magento_root>
14+
```
15+
16+
```bash
17+
chmod -R g+w var vendor pub/static pub/media app/etc
18+
```
19+
20+
```bash
21+
chmod u+x bin/magento
22+
```
23+
24+
To optionally enter all commands on one line, enter the following assuming Magento is installed in `/var/www/html/magento2`:
25+
26+
```bash
27+
cd /var/www/html/magento2 && chmod -R g+w var vendor pub/static pub/media app/etc && chmod u+x bin/magento
28+
```
29+
30+
After you set file system permissions, manually clear the `var/cache`, `var/page_cache`, and `generated` directories.
31+
32+
A sample command follows:
33+
34+
```bash
35+
rm -rf var/cache/* var/page_cache/* generated/*
36+
```
37+
38+
#### Two-user ownership and permissions
39+
40+
If you run the Magento application with two users, enter the following commands as a user with `root` privileges:
41+
42+
```bash
43+
cd <magento_root>
44+
```
45+
46+
```bash
47+
find var vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
48+
```
49+
50+
```bash
51+
find var vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
52+
```
53+
54+
```bash
55+
chown -R :<web server group> .
56+
```
57+
58+
```bash
59+
chmod u+x bin/magento
60+
```
61+
62+
To optionally enter all commands on one line, enter the following assuming Magento is installed in `/var/www/html/magento2` and the web server group name is `apache`:
63+
64+
```bash
65+
cd /var/www/html/magento2 && find var vendor pub/static pub/media app/etc -type f -exec chmod g+w {} + && find var vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} + && chown -R :apache . && chmod u+x bin/magento
66+
```
67+
68+
<!-- Link definitions -->
69+
[Overview of ownership and permissions]: {{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
2+
## Install sample data by cloning repositories {#sample-clone}
3+
4+
This topic discusses how to clone and add Magento sample data if you cloned the Magento GitHub repository. This method is intended only for contributing developers (that is, developers who plan to contribute to the Magento 2 codebase).
5+
6+
If you're not a contributing developer, choose one of the other options displayed in the table of contents on the left side of the page.
7+
8+
Contributing developers can use this method of installing sample data *only* if all of the following are true:
9+
10+
* You use {{site.data.var.ce}}
11+
* You [cloned the Magento 2 repository]({{ page.baseurl }}/install-gde/prereq/dev_install.html).
12+
13+
{:.bs-callout-warning}
14+
You can use sample data with either the `develop` branch (more current) or a released branch (such as `2.4` (more stable)). We recommend you use a released branch because it's more stable. If you're contributing code to the Magento 2 repository and you need the most recent code, use the `develop` branch. Regardless of the branch you choose, you must [clone]({{ page.baseurl }}/install-gde/prereq/dev_install.html) the corresponding branch of the Magento 2 GitHub repository. For example, sample data for the `develop` branch can be used *only* with the Magento 2 `develop` branch.
15+
16+
See the following sections:
17+
18+
* [Clone the sample data repository](#clone-sample-repo)
19+
* [Set file system ownership and permissions](#samp-data-perms)
20+
21+
## Clone the sample data repository {#clone-sample-repo}
22+
23+
This section discusses how to install Magento sample data by cloning the sample data repository. You can clone the sample data repository in any of the following ways:
24+
25+
* Clone with the [SSH protocol](#clone-sample-repo-ssh)
26+
* Clone with the [HTTPS protocol](#instgde-prereq-compose-clone-https)
27+
28+
### Clone with SSH {#clone-sample-repo-ssh}
29+
30+
To clone the Magento sample data GitHub repository using the SSH protocol:
31+
32+
1. In a web browser, go to [the Magento sample data repository](https://github.com/magento/magento2-sample-data).
33+
1. Next to the name of the branch, click **SSH** from the list.
34+
1. Click **Copy to clipboard**
35+
36+
The following figure shows an example.
37+
38+
![Clone the Magento GitHub repository using SSH]({{ site.baseurl }}/common/images/install_mage2_clone-ssh.png){:width="650px"}
39+
40+
1. Change to your web server's docroot directory.
41+
42+
Typically, for Ubuntu, it's `/var/www` and for CentOS it's `/var/www/html`.
43+
44+
Need [help locating the docroot?]({{ page.baseurl }}/install-gde/basics/basics_docroot.html)
45+
46+
1. Enter `git clone` and paste the value you obtained from step 1.
47+
48+
An example follows:
49+
50+
```bash
51+
git clone git@github.com:magento/magento2-sample-data.git
52+
```
53+
54+
1. Wait for the repository to clone on your server.
55+
56+
{:.bs-callout-info}
57+
If the following error displays, make sure you [shared your SSH key](https://help.github.com/articles/generating-ssh-keys/) with GitHub:<br>
58+
59+
```terminal
60+
Cloning into 'magento2'...
61+
Permission denied (publickey).
62+
fatal: The remote end hung up unexpectedly
63+
```
64+
65+
1. Ensure you checkout the branch of the sample data repository that corresponds with the branch you used from the main `magento2` repository.
66+
67+
For example:
68+
69+
If you used the `2.4-develop` branch of the Magento 2 repository, the Sample Data branch should be `2.4-develop`.
70+
71+
If you used the `2.4.1` branch of the Magento 2 repository, the Sample Data branch should be `2.4.1`.
72+
73+
To checkout the correct branch, run the following command from the sample data repository's root directory (assuming you need the `2.4.1` branch):
74+
75+
```bash
76+
git checkout 2.4.1
77+
```
78+
79+
1. Change to `<magento_root>`.
80+
1. Enter the following command to create symbolic links between the files you just cloned so sample data works properly:
81+
82+
```bash
83+
php -f <sample-data_clone_dir>/dev/tools/build-sample-data.php -- --ce-source="<path_to_your_magento_instance>"
84+
```
85+
86+
1. Wait for the command to complete.
87+
88+
1. See [Set file system permissions and ownership](#samp-data-perms).
89+
90+
### Clone with HTTPS {#instgde-prereq-compose-clone-https}
91+
92+
To clone the Magento sample data GitHub repository using the HTTPS protocol:
93+
94+
1. In a web browser, go to [the Magento sample data repository](https://github.com/magento/magento2-sample-data).
95+
1. On the right side of the page, under the **clone URL** field, click **HTTPS**.
96+
1. Click **Copy to clipboard**.
97+
98+
The following figure shows an example.
99+
100+
![Clone the Magento GitHub repository using HTTPS]({{ site.baseurl }}/common/images/install_mage2_clone-https.png){:width="650px"}
101+
102+
1. Change to your web server's docroot directory.
103+
104+
Typically, for Ubuntu, it's `/var/www` and for CentOS it's `/var/www/html`.
105+
106+
1. Enter `git clone` and paste the value you obtained from step 1.
107+
108+
An example follows:
109+
110+
```bash
111+
git clone https://github.com/magento/magento2-sample-data.git
112+
```
113+
114+
1. Wait for the repository to clone on your server.
115+
1. Ensure you checkout the branch of the sample data repository that corresponds with the branch you used from the main `magento2` repository.
116+
117+
For example:
118+
119+
If you used the `2.4-develop` branch of the Magento 2 repository, the Sample Data branch should be `2.4-develop`.
120+
121+
If you used the `2.4.1` branch of the Magento 2 repository, the Sample Data branch should be `2.4.1`.
122+
123+
To checkout the correct branch, run the following command from the sample data repository's root directory (assuming you need the `2.4.1` branch):
124+
125+
```bash
126+
git checkout 2.4.1
127+
```
128+
129+
1. Change to `<magento_root>`.
130+
1. Enter the following command to create symbolic links between the files you just cloned so sample data works properly:
131+
132+
```bash
133+
php -f <sample-data_clone_dir>/dev/tools/build-sample-data.php -- --ce-source="<path_to_your_magento_instance>"
134+
```
135+
136+
For example,
137+
138+
```bash
139+
php -f <sample-data_clone_dir>/dev/tools/build-sample-data.php -- --ce-source="/var/www/magento2"
140+
```
141+
142+
1. Wait for the command to complete.
143+
1. See the next section.
144+
145+
{:.bs-callout-warning}
146+
If you're installing sample data _after_ installing Magento, you must also run the following command to update the database and schema:
147+
148+
```bash
149+
<magento_root>/bin/magento setup:upgrade
150+
```
151+
152+
## Set file system ownership and permissions {#samp-data-perms}
153+
154+
Because the `php build-sample-data.php` script creates symlinks between the sample data repository and your Magento 2 repository, you must set file system permissions and ownership in the sample data repository. Failure to do so results in errors accessing the storefront.
155+
156+
To set file system permissions and ownership on the sample data repository:
157+
158+
1. Change to your sample data clone directory.
159+
1. Set ownership:
160+
161+
```bash
162+
chown -R :<your web server group name> .
163+
```
164+
165+
Typical examples:
166+
167+
* CentOS: `chown -R :apache .`
168+
169+
* Ubuntu: `chown -R :www-data .`
170+
171+
1. Set permissions:
172+
173+
```bash
174+
find . -type d -exec chmod g+ws {} +
175+
```
176+
177+
1. Clear static files:
178+
179+
```bash
180+
cd <your {{site.data.var.ce}} install dir>
181+
```
182+
183+
```bash
184+
rm -rf var/cache/* var/page_cache/* generated/*
185+
```
186+
187+
<!-- ABBREVIATIONS -->
188+
189+
*[contributing developer]: A developer who contributes code to the Magento 2 CE codebase
190+
*[contributing developers]: Developers who contribute code to the Magento 2 CE codebase
191+
*[Contributing developers]: Developers who contribute code to the Magento 2 CE codebase

src/_includes/install/sampledata/sample-data-rc1-cli-24.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ After you have reset file system permissions:
6565

6666
1. If you have not done so already, log in to your Magento server as, or switch to, the Magento file system owner.
6767
1. Change to your Magento installation directory.
68-
1. Manually clear the `var/cache`, `var/page_cache`, and `var/generation` directories.
68+
1. Manually clear the `var/cache`, `var/page_cache`, and `generated` directories.
6969

7070
A sample command follows:
7171

7272
```bash
73-
rm -rf var/cache/* var/page_cache/* var/generation/*
73+
rm -rf var/cache/* var/page_cache/* generated/*
7474
```
7575

7676
1. Upgrade Magento:
@@ -79,7 +79,7 @@ After you have reset file system permissions:
7979
bin/magento setup:upgrade
8080
```
8181

82-
{% include install/sampledata/file-sys-perms-digest.md %}
82+
{% include install/sampledata/file-sys-perms-digest-24.md %}
8383

8484
<!-- Link definitions -->
8585
[Magento file system owner]: {{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html

src/cloud/cdn/configure-fastly.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,9 @@ To update your DNS configuration for development:
185185

186186
When the CNAME records are live, Magento provisions certificates and uploads the SSL/TLS certificates.
187187

188+
{:.bs-callout-info}
189+
If you plan to use apex domains (`your-domain.com`) for your Production site, you must configure DNS address records (A records) to point to the Fastly server IP addresses. See [Update DNS configuration with production settings]({{ site.baseurl }}/cloud/live/site-launch-checklist.html#dns).
190+
188191
1. Add ACME challenge CNAME records for domain validation and pre-provisioning of Production SSL/TLS certificates, for example:
189192

190193
| Domain or Subdomain | CNAME
@@ -206,7 +209,7 @@ To update your DNS configuration for development:
206209

207210
- Use the Magento CLI to change the base URL for your store.
208211

209-
```
212+
```bash
210213
php bin/magento setup:store-config:set --base-url="https://mcstaging.your-domain.com/"
211214
```
212215

src/cloud/live/site-launch-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ To update DNS configuration for site launch:
7777

7878
- Use the Magento CLI to change the base URL for your store.
7979

80-
```
80+
```bash
8181
php bin/magento setup:store-config:set --base-url="https://www.your-domain.com/"
8282
```
8383

0 commit comments

Comments
 (0)