You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardexpand all lines: README.md
+6-32
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Adobe Commerce Developer Documentation
2
2
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://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md).
3
+
This project contains the source code of the Adobe Commerce and Magento Open Source developer documentation website for the latest 2.3 release of both products.
4
4
5
5
> **Important update**
6
6
>
@@ -13,12 +13,8 @@ Welcome! This site contains the latest Adobe Commerce and Magento Open Source de
13
13
> Some content was consolidated or moved to different guides. If you have trouble finding a topic, see the [Migrated topics](https://devdocs.magento.com/migrated.html).
14
14
>
15
15
> We welcome contributions to migrated content! You can find similar links to GitHub on the Adobe sites.
16
-
17
-
## Contributors
18
-
19
-
Our goal is to provide the Commerce and 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.
> The content at https://devdocs.magento.com is no longer supported since the (2.3 support has expired)[https://experienceleague.adobe.com/docs/commerce-operations/release/versions.html#2.3].
22
18
23
19
## Building this site
24
20
@@ -133,30 +129,9 @@ Once you have completed preparing your environment, you can build locally and pr
133
129
>***TIP***
134
130
> Leave the serve terminal open and running. Every time you save changes to a file, it automatically regenerates the site so you can test the output immediately. Changing the `_config.yml` file or other YAML file with data or configuration requires a fresh build (stop and start the server again with `rake preview`).
135
131
136
-
### Exclude private repositories
137
-
138
-
If you do not have access to the private repositories required by Docfile, you can exclude them in`_config.local.yml` to avoid the link checking report about missing pages.
139
-
140
-
Create a `_config.local.yml` file at the root of the project directory and exclude the paths you do not want to generate:
141
-
142
-
```yaml
143
-
exclude:
144
-
- page-builder
145
-
```
146
-
147
-
>**TIP**
148
-
>You can override any other configuration options using this file.
149
-
150
-
>**TIP**
151
-
>To ignore the `_config.local.yml` file and preview the site with default configuration, use the `preview:all` option :
152
-
>
153
-
>```bash
154
-
>rake preview:all
155
-
>```
156
-
157
132
## Building old versions
158
133
159
-
The published website contains documentation forthe most current Adobe Commerce and Magento Open Source releases only. For cases, when you need to view the content as it was for an earlier release, we created [tags](https://github.com/magento/devdocs/tags)in this repository. Typically, they point at the commit when the release notes were finalized and published.
134
+
The published website contains documentation forthe latest 2.3.x Adobe Commerce and Magento Open Source release only. For cases, when you need to view the content as it was for an earlier release, we created [tags](https://github.com/magento/devdocs/tags)in this repository. Typically, they point at the commit when the release notes were finalized and published.
160
135
161
136
To view the list of available tags:
162
137
@@ -177,12 +152,11 @@ Find guidelines for building the site locally in the checked out README.
177
152
178
153
## Archived docs
179
154
180
-
To view the archived documentation, see <http://magento.github.io/devdocs/>.
155
+
To view the archived documentation, see <https://commerce-docs.github.io/devdocs-archive/>.
181
156
182
157
***
183
158
184
-
If you have questions, open an issue and ask us. We're looking forward to hearing from you!
0 commit comments