|
1 |
| -# Commerce PHP Documentation |
| 1 | +# Adobe Commerce Developer Documentation |
2 | 2 |
|
3 |
| -This site uses Yarn 3 to manage package dependencies. |
4 |
| -If you do not have Yarn 3 installed, follow these instructions: |
| 3 | +Welcome! This site contains the latest Adobe Commerce and Magento Open Source developer documentation for ongoing releases of both products. For additional information, see our [Contribution Guide](https://developer.adobe.com/commerce/contributor/). |
5 | 4 |
|
6 |
| -1. Install [Node.js LTS](https://nodejs.org/en/download/). At the time of writing, the latest LTS version is `v16.15.1`. |
7 |
| -2. Install Yarn 3 by running the following command: |
| 5 | +## Contributors |
8 | 6 |
|
9 |
| - ```bash |
10 |
| - corepack enable |
11 |
| - ``` |
12 |
| - |
13 |
| -Corepack is a binary shipped with all Node.js releases starting from 16.10. |
14 |
| - |
15 |
| -3. Update Yarn to the latest version by running the following command: |
| 7 | +Our goal is to provide the Adobe Commerce and Magento Open Source communities with comprehensive and quality technical documentation. We believe that to accomplish that goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving the documentation. |
16 | 8 |
|
17 |
| - ```bash |
18 |
| - yarn set version stable |
19 |
| - ``` |
| 9 | + |
20 | 10 |
|
21 |
| -4. Make sure you are now using version 3.2.2 of Yarn:. |
| 11 | +## Local development |
22 | 12 |
|
23 |
| - ```bash |
24 |
| - yarn --version |
25 |
| - ``` |
| 13 | +This is a [Gatsby](https://www.gatsbyjs.com/) project that uses the [Adobe I/O Theme](https://github.com/adobe/aio-theme). |
26 | 14 |
|
27 |
| -That's it. For more information on Yarn 3 usage, see [Yarn usage](https://yarnpkg.com/getting-started/usage). |
| 15 | +To build the site locally: |
28 | 16 |
|
29 |
| -## How to build the documentation |
30 |
| - |
31 |
| -To build this site locally and contribute changes, follow these steps: |
32 |
| - |
33 |
| -1. Fork the repo into your own account, then clone it to a local directory. |
34 |
| - |
35 |
| - ```bash |
36 |
| - git clone git@github.com:AdobeDocs/commerce-php.git |
37 |
| - ``` |
38 |
| - |
39 |
| -2. In the repo's root, run this command to install dependencies: |
| 17 | +1. Clone this repo. |
| 18 | +1. Install project dependencies. |
40 | 19 |
|
41 | 20 | ```bash
|
42 | 21 | yarn install
|
43 | 22 | ```
|
44 | 23 |
|
45 |
| -3. Run this command to build the site locally and auto-launch your browser: |
| 24 | +1. Launch the project in development mode. |
46 | 25 |
|
47 | 26 | ```bash
|
48 | 27 | yarn dev
|
49 | 28 | ```
|
50 | 29 |
|
51 |
| -## Using enhanced markdown features |
| 30 | +## Resources |
52 | 31 |
|
53 |
| -To learn about all the enhanced markdown features you can use, see the [Adobe I/O Theme README](https://github.com/adobe/aio-theme#adobe-io-theme). |
54 |
| -Highlights include: |
| 32 | +See the following resources to learn more about using the theme: |
55 | 33 |
|
56 |
| -- [Arrange the structure content of your docs](https://github.com/adobe/aio-theme#content-structure) |
| 34 | +- [Arranging content structure](https://github.com/adobe/aio-theme#content-structure) |
57 | 35 | - [Linking to pages](https://github.com/adobe/aio-theme#links)
|
58 |
| -- [Using assets](https://github.com/adobe/aio-theme-aio#assets) |
59 |
| -- [Setting Global Navigation](https://github.com/adobe/aio-theme#global-navigation) |
60 |
| -- [Setting Side Navigation](https://github.com/adobe/aio-theme#side-navigation) |
| 36 | +- [Using assets](https://github.com/adobe/aio-theme#assets) |
| 37 | +- [Configuring global navigation](https://github.com/adobe/aio-theme#global-navigation) |
| 38 | +- [Configuring side navigation](https://github.com/adobe/aio-theme#side-navigation) |
61 | 39 | - [Using content blocks](https://github.com/adobe/aio-theme#jsx-blocks)
|
62 |
| -- [Notes on using Markdown](https://github.com/adobe/aio-theme#writing-enhanced-markdown) |
| 40 | +- [Writing enhanced Markdown](https://github.com/adobe/aio-theme#writing-enhanced-markdown) |
| 41 | +- [Deploying the site](https://github.com/adobe/aio-theme#deploy-to-azure-storage-static-websites) _(Adobe employees only)_ |
| 42 | + |
| 43 | +If you have questions, open an issue and ask us. We look forward to hearing from you! |
0 commit comments