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

Commit d1fe87f

Browse files
authored
Merge branch 'master' into cli-short-command-name
2 parents afbcfcc + 1b120ed commit d1fe87f

File tree

2,086 files changed

+1293
-198511
lines changed

Some content is hidden

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

2,086 files changed

+1293
-198511
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ The following guidelines may answer most of your questions and help you get star
7171
For example:
7272

7373
```bash
74-
git rm guides/v2.2/install-gde/composer.md
74+
git rm guides/v2.3/install-gde/composer.md
7575
```
7676

7777
```bash
78-
cp guides/v2.1/install-gde/composer.md guides/v2.2/install-gde/composer.md
78+
cp guides/v2.2/install-gde/composer.md guides/v2.3/install-gde/composer.md
7979
```
8080

81-
- Make sure that you update the correct version(s) of documentation (v2.1, v2.2, v2.3). If you are not sure what directory to put your content in, just do your best. We can help re-locate it (if necessary) during the review process.
81+
- Make sure that you update the correct version(s) of documentation (v2.2, v2.3). If you are not sure what directory to put your content in, just do your best. We can help re-locate it (if necessary) during the review process.
8282
- Review your work for basic typos, formatting errors, or ambiguous sentences before opening a pull request.
8383
- Revise pull requests according to review feedback. We will close pull requests that require an inordinate amount of time to review and process (especially for minor changes) if you fail to make revisions according to review feedback.
8484
- Do not directly contact DevDocs team members or maintainers on Slack to review your pull request unless it has been open for more than five days. We have a process and queue for pull requests that everyone must follow.
@@ -105,11 +105,11 @@ _(Optional)_ To review your changes in HTML output, follow the instructions in t
105105

106106
We provide templates to help you get started writing new content and understanding Markdown formatting:
107107

108-
- **General topic template** - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.1/contributor-guide/templates/basic_template.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/basic_template.html): This is a template for writing any topic with example formats and styles.
108+
- **General topic template** - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.3/contributor-guide/templates/basic_template.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/basic_template.html): This is a template for writing any topic with example formats and styles.
109109
- **Tutorial templates**: These templates provide example formats and styles for step-by-step instructions (like how-tos). Each file adds navigation buttons when content is generated. Templates include:
110-
- First introduction topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.1/contributor-guide/templates/tutorial-template-first.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-first.html): Introduction to a tutorial for prerequisites and listing steps
111-
- Middle topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.1/contributor-guide/templates/tutorial-template-middle.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-middle.html): Use for each step in a tutorial.
112-
- Final step topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.1/contributor-guide/templates/tutorial-template-last.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-last.html): Use for the last step of the tutorial.
110+
- First introduction topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.3/contributor-guide/templates/tutorial-template-first.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-first.html): Introduction to a tutorial for prerequisites and listing steps
111+
- Middle topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.3/contributor-guide/templates/tutorial-template-middle.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-middle.html): Use for each step in a tutorial.
112+
- Final step topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.3/contributor-guide/templates/tutorial-template-last.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-last.html): Use for the last step of the tutorial.
113113

114114
### Edit metadata
115115

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ _algolia_api_key
3333
###################################
3434

3535
/guides/v2.0/
36+
/guides/v2.1/

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Our goal is to provide the Magento community with comprehensive and quality tech
1313
You can build this site locally in the following ways:
1414

1515
- [Installing the project dependencies locally](#build-using-jekyll) (Mac, Linux)
16-
1716
- [Using a Vagrant virtual machine](#build-using-vagrant) (Mac, Linux, Windows)
1817
- [Build DevDocs in Windows](#build-devdocs-in-windows) (Windows 7 & 10)
1918

@@ -178,6 +177,38 @@ To build v2.0 documentation:
178177
rake preview
179178
```
180179

180+
### To build v2.1 documentation
181+
182+
Magento 2.1.18 was the final 2.1.x release. After June 2019, Magento 2.1.x stopped receiving security patches, quality fixes, and documentation updates.
183+
184+
To ensure the quality of our public documentation for versions of Magento that are still supported and to avoid potential confusion about 2.1.x support, we removed all 2.1.x content from our public documentation websites on July 11, 2019.
185+
186+
To build v2.1 documentation:
187+
188+
> Also, you can use the GitHub interface to read the source Markdown files instead of building the site locally. Navigate to the [`2.1`](https://github.com/magento/devdocs/tree/2.1) branch and click the file you want to view.
189+
190+
1. Add an entry for 2.1 in the `Docfile.yml` file.
191+
192+
```yaml
193+
-
194+
directory: guides/v2.1
195+
repository: magento/devdocs
196+
branch: 2.1
197+
filter: false
198+
```
199+
200+
1. Initialize the `2.1` branch in your local devdocs repository.
201+
202+
```shell
203+
rake init
204+
```
205+
206+
1. Run the preview command.
207+
208+
```shell
209+
rake preview
210+
```
211+
181212
## Build using Vagrant
182213

183214
You can deploy the devdocs site locally using [this Vagrant project](https://github.com/magento-devdocs/vagrant-for-magento-devdocs).

_config.yml

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ baseurl: ""
1919
#
2020
version: "2.3"
2121
versions:
22-
-
23-
name: "2.1"
24-
url: /guides/v2.1/
2522
-
2623
name: "2.2"
2724
url: /guides/v2.2/
@@ -102,11 +99,7 @@ defaults:
10299
group: module-reference-guide-2_3
103100
github_link: false
104101
feedback_link: false
105-
-
106-
scope:
107-
path: guides/v2.1
108-
values:
109-
sitemap: false
102+
110103
-
111104
scope:
112105
path: guides/v2.2
@@ -197,10 +190,6 @@ mage2bloburl: https://github.com/magento/magento2/blob
197190
m1xgdeurl: /guides/m1x
198191
m1xgithuburl: https://github.com/magento/devdocs/blob/master
199192

200-
# 2.1 variables
201-
gdeurl21: /guides/v2.1/
202-
githuburl21: https://github.com/magento/devdocs/tree/master/guides/v2.1/
203-
204193
# 2.2 variables
205194
gdeurl22: /guides/v2.2/
206195
githuburl22: https://github.com/magento/devdocs/tree/master/guides/v2.2/

_data/toc/javascript-developer-guide.yml

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

9191
- label: Tabs widget
9292
url: /javascript-dev-guide/widgets/widget_tabs.html
93+
94+
- label: ToggleAdvanced widget
95+
url: /javascript-dev-guide/widgets/widget_toggle.html

_data/toc/ui-components-guide.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ pages:
2525
- label: Checkboxset component
2626
url: /ui_comp_guide/components/ui-checkboxset.html
2727

28+
- label: ColorPicker component
29+
include_versions: ["2.3"]
30+
url: /ui_comp_guide/components/ui-colorpicker.html
31+
2832
- label: Column component
2933
url: /ui_comp_guide/components/ui-column.html
3034

0 commit comments

Comments
 (0)