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

Commit

Permalink
Sync develop with master (#6019)
Browse files Browse the repository at this point in the history
* Fixed incorrect module dependency examples

* update file extension

* Fix small grammatical issue

  - Missing article

* Fixed incorrect link syntax

* Fix staging

Use double quotes for Build number variable in rake build:stage

* Fix staging

Replace a bash variable with ENV syntax in rake build:stage

* Improving the Range UiComponent

* Improving the Checkbox UiComponent documentation

* magento/devdocs#: Add deleteCustomerAddress mutation API errors

- https://devdocs.magento.com/guides/v2.3/graphql/mutations/delete-customer-address.html

* Adding the widget available options

* Update theme-create.md

* Product availability updates (#5984)

* Added product recs

* Added qualification for Google extension

* magento/devdocs#: Add updateCustomerAddress mutation API errors

- https://devdocs.magento.com/guides/v2.3/graphql/mutations/update-customer-address.html

* Editing for grammar

* Editing for grammar

* Table formatting

* Grammar

* magento/devdocs#: Extends information about creating a dynamic row system config.

- https://devdocs.magento.com/guides/v2.2/ext-best-practices/tutorials/dynamic-row-system-config.html
- https://devdocs.magento.com/guides/v2.3/ext-best-practices/tutorials/dynamic-row-system-config.html

* Add site switcher to the header (#5983)

* Add site switcher to the header

* Change site-nav.html to add the button

* Add contributor metadata info

* Removed workflows file

* Change wording

Change mention of notation to "attribution" and implement limitation on accepted links per Jeff's review

* Added PHP note

added a note regarding required PHP setting for Google reCAPTCHA. This update was vetted and approved by Rick Tempesta.

* Small grammar fix

* [ImgBot] Optimize images

/common/images/ext-best-practices/dynamic-rows-config-result.png -- 61.37kb -> 30.32kb (50.59%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

* Update database-caching.md

Fix Identation of XML code.

* Adding new example

New example using SearchCriteria with getList

* Update create-cache-type.md

Namespace not is in default model used by Magento FrameWork

* Update lifecycle.md

Alter definition of class, not good practice.

* Add rake index with dry run

* Cloud 2002.0.22 (#5997)

- Consolidate versioned release notes to one topic
- Replace v2.3 release notes with symlink
- Add section for 2002.0.22 release notes
- Remove obsolete version information from the Cloud TOC file
- Revised release notes to explain
changes to ece-tools and cloud patches
components more clearly and concisely
- Changed list of patches to fixes

* Update rake multirepo:init

Use ruby syntax for environment variable
Exit if rake init fails on checkout

* Typo fix

* Update rake index

Remove --dry-run
Add output message

* Refactor rake init

Replaced 'print + exit' with equal 'abort'

* Update rake mutirepo tasks

Add rake reinit
Refactor

* Formatting

* Formatting

* Add caution for 'rake multirepo:reinit'

* Remove typos in command

* Update guides/v2.3/security/google-recaptcha.md

Accepted approver's suggestion

Co-Authored-By: Shrie Spangler <spangler@adobe.com>

* fixed broken link
  • Loading branch information
keharper authored Nov 18, 2019
1 parent 54ec63d commit a8a8148
Show file tree
Hide file tree
Showing 34 changed files with 423 additions and 696 deletions.
22 changes: 0 additions & 22 deletions .github/workflows/main.yml

This file was deleted.

6 changes: 3 additions & 3 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
GIT
remote: https://github.com/magento-devdocs/devdocs-theme.git
revision: 5e99a84dd5692d3ee4c1985b9f48824eeede8cfd
revision: 7628949ce6d16a6232a0582b32465757a6e446a9
specs:
devdocs (5)
jekyll (>= 3.3)
devdocs (7)
jekyll (>= 4.0)

GEM
remote: https://rubygems.org/
Expand Down
10 changes: 9 additions & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ task :whatsnew do
elsif date.is_a? String
sh 'bin/whatsup_github', 'since', ENV['since'].to_s
else
puts 'The "since" argument must be a string/ Example: "jul 4"'
puts 'The "since" argument must be a string. Example: "jul 4"'
end
end

desc 'Generate index for Algolia'
task index: %w[init] do
puts 'Generating index for Algolia ...'
sh 'bin/jekyll',
'algolia',
'--config=_config.yml,_config.index.yml'
end
50 changes: 10 additions & 40 deletions _data/toc/cloud-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,6 @@ pages:
- label: Git
url: /cloud/reference/git-integration.html

- label: Bitbucket integration
url: /cloud/project/bitbucket-integration.html
include_versions: ["2.0"]

- label: GitHub integration
url: /cloud/project/project-integrate-github.html
include_versions: ["2.0"]

- label: SSH and sFTP
url: /cloud/env/environments-ssh.html

Expand Down Expand Up @@ -138,7 +130,6 @@ pages:

- label: Set up PayPal
url: /cloud/live/paypal-onboarding.html
exclude_versions: ["2.0"]

- label: Set up Magento B2B
url: /cloud/configure/setup-b2b.html
Expand All @@ -165,22 +156,20 @@ pages:
children:
- label: Set up Fastly
url: /cloud/cdn/configure-fastly.html
exclude_versions: ["2.0"]
children:
- label: Customize error pages
url: /cloud/cdn/cloud-fastly-custom-response.html

- label: Web Application Firewall
url: /cloud/cdn/fastly-waf-service.html
exclude_versions: ["2.0"]

- label: Image Optimization
url: /cloud/cdn/fastly-image-optimization.html
exclude_versions: ["2.0"]

- label: Custom VCL snippets
url: /cloud/cdn/cloud-vcl-custom-snippets.html
exclude_versions: ["2.0"]

children:
- label: Reroute requests to a CMS backend
url: /cloud/cdn/fastly-vcl-wordpress.html
Expand Down Expand Up @@ -208,7 +197,7 @@ pages:

- label: Build and deploy
url: /cloud/project/magento-env-yaml.html
exclude_versions: ["2.0"]

children:
- label: Set up notifications
url: /cloud/env/setup-notifications.html
Expand All @@ -224,28 +213,23 @@ pages:

- label: Global variables
url: /cloud/env/variables-global.html
exclude_versions: ["2.0"]


- label: Build variables
url: /cloud/env/variables-build.html
exclude_versions: ["2.0"]


- label: Cloud variables
url: /cloud/env/variables-cloud.html
include_versions: ["2.1","2.2","2.3"]

- label: Deploy variables
url: /cloud/env/variables-deploy.html
exclude_versions: ["2.0"]

- label: Post-deploy variables
url: /cloud/env/variables-post-deploy.html
exclude_versions: ["2.0"]


- label: Working with variables
url: /cloud/env/working-with-variables.html
exclude_versions: ["2.0"]


- label: Routes
url: /cloud/project/project-conf-files_routes.html
children:
Expand All @@ -267,20 +251,15 @@ pages:
- label: Set up Redis service
url: /cloud/project/project-conf-files_services-redis.html

- label: Set up Solr service
url: /cloud/project/project-conf-files_services-solr.html
include_versions: ["2.0"]

- label: Set up Elasticsearch service
url: /cloud/project/project-conf-files_services-elastic.html
exclude_versions: ["2.0"]


- label: Set up RabbitMQ service
url: /cloud/project/project-conf-files_services-rabbit.html

- label: Configuration management for store settings
url: /cloud/live/sens-data-over.html
include_versions: ["2.1","2.2","2.3"]
include_versions: [2.2","2.3"]
children:
- label: Example of managing system-specific settings
url: /cloud/live/sens-data-initial.html
Expand Down Expand Up @@ -381,7 +360,6 @@ pages:

- label: Reset cron jobs
url: /cloud/trouble/reset-cron-jobs.html
exclude_versions: ["2.0"]

- label: Resolve issues with encryption key
url: /cloud/trouble/trouble-crypt-key-variable.html
Expand All @@ -394,7 +372,6 @@ pages:

- label: Restore configuration files
url: /cloud/trouble/restore-configuration-files.html
exclude_versions: ["2.0"]

- label: Site availability
url: /cloud/trouble/site-availability.html
Expand All @@ -408,24 +385,17 @@ pages:
- label: Upgrades and patches
url: /cloud/project/project-upgrade-parent.html
children:
- label: Release notes for ece-tools
url: /cloud/release-notes/cloud-tools.html
exclude_versions: ["2.0"]

- label: Upgrade to use ece-tools
url: /cloud/project/ece-tools-upgrade-project.html
exclude_versions: ["2.0"]

- label: Update ece-tools version
url: /cloud/project/ece-tools-update.html
exclude_versions: ["2.0"]

- label: Apply custom patches
url: /cloud/project/project-patch.html

- label: Upgrade Magento version
url: /cloud/project/project-upgrade.html

- label: Upgrade from 2.0.4 (Cloud)
include_versions: ["2.0"]

- label: Release notes
url: /cloud/release-notes/cloud-tools.html
27 changes: 16 additions & 11 deletions _includes/layout/site-nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

<nav class="site-nav">

<div class="menu-btn">
<button id="menu-btn" class="menu-trigger menu-icon" aria-haspopup="true" aria-controls="nav-main" aria-label="Menu"></button>
</div>

<div class="nav-container">

<div class="menu-btn">
<button id="menu-btn" class="menu-trigger menu-icon" aria-haspopup="true" aria-controls="nav-main" aria-label="Menu"></button>
</div>

<a class="logo" href="{% if page.guide_version == site.version or page.guide_version == nil %}{{ site.baseurl }}{% else %}{{ page.baseurl }}{% endif %}/">
<img src="{{ site.baseurl }}/assets/i/m-logo.svg" alt=""><img src="{{ site.baseurl }}/assets/i/magento-logo.svg" alt="Magento" class="magento-logo" />
<span class="site-logo">{{ site.logo }}</span>
Expand All @@ -23,14 +23,19 @@
{% include layout/navigation.html %}
</div>

<div class="search-btn">
<button class="search-trigger search-icon" aria-label="Search"></button>
</div>
<div class="nav-actions">
{% include layout/app-switcher.html %}

<div class="search-btn">
<button class="search-trigger search-icon" aria-label="Search"></button>
</div>

<form class="quick-search" action="{{ page.baseurl }}/search.html" method="get" novalidate="novalidate">
<input type="search" name="query" placeholder="Search" />
<button class="quick-search-close" aria-label="Close Search">&times;</button>
</form>
<form class="quick-search" action="{{ page.baseurl }}/search.html" method="get" novalidate="novalidate">
<input type="search" name="query" placeholder="Search" />
<button class="quick-search-close" aria-label="Close Search">&times;</button>
</form>

</div>

</div>

Expand Down
Binary file modified common/images/ext-best-practices/dynamic-rows-config-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added common/images/ui_comps/date-range-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added common/images/ui_comps/text-range-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The `require` section of `app/code/<Vendor>/<Module>/composer.json` file contain
"magento/module-variable": "100.3.*",
"magento/module-widget": "101.1.*",
"magento/module-authorization": "100.3.*"
},
}
...
```

Expand All @@ -57,15 +57,27 @@ A module with a *soft dependency* on another module can function properly withou
* Extend another module's configuration.
* Extend another module's [layout](https://glossary.magento.com/layout).

The `<sequence>` section of `app/code/<Vendor>/<Module>/etc/module.xml` file contains soft dependency definitions for the module. For example:
The `suggest` section of `app/code/<Vendor>/<Module>/composer.json` file contains soft dependency definitions for the module. For example:

```json
...
"suggest": {
"magento/module-graph-ql": "*",
"magento/module-graph-ql-cache": "*",
"magento/module-store-graph-ql": "*"
}
...
```

The `<sequence>` node of `app/code/<Vendor>/<Module>/etc/module.xml` file also contains soft dependency definitions for the module. For example:

```xml
<module name="Magento_Cms">
<sequence>
<module name="Magento_Store"/>
<module name="Magento_Theme"/>
<module name="Magento_Variable"/>
</sequence>
<sequence>
<module name="Magento_Store"/>
<module name="Magento_Theme"/>
<module name="Magento_Variable"/>
</sequence>
</module>
```

Expand Down
6 changes: 3 additions & 3 deletions guides/v2.2/cloud/project/project-integrate-blackfire.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,11 +235,11 @@ By simply defining a set of key requests for Blackfire to profile— `/home`, `/

### Writing your first automated tests and scenarios

You can easily write tests and scenarios for Blackfire to execute. Create a `.blackfire.yml` file and store it at your project root directory.
You can easily write tests and scenarios for Blackfire to execute. Create a `.blackfire.yaml` file and store it at your project root directory.

Try adding the following scenarios in the file:

> .blackfire.yml
> .blackfire.yaml

```yaml
scenarios:
Expand All @@ -257,7 +257,7 @@ See the Blackfire documentation on [Writing tests](https://blackfire.io/docs/coo

### Running your tests automatically {#automation}

Once you create and deploy your `.blackfire.yml` file, you can enable Blackfire to run your tests automatically in various ways:
Once you create and deploy your `.blackfire.yaml` file, you can enable Blackfire to run your tests automatically in various ways:

- **Automated builds on Integration**—Whenever you push code on an Integration, Staging, or Production branch, Blackfire automatically runs your tests. You can receive a notification of the results in various ways, such as a commit status level when using GitHub or Bitbucket. See Blackfire notifications.

Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/cloud/project/user-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ The user you add receives an email inviting them to join the {{site.data.var.ece
After you add a new user to an environment, you must rebuild and deploy the environment. Rebuilds are triggered when you push a new commit to an environment. To trigger a rebuild without changing any code, use the the following command to to create an empty commit and "force" rebuilding the environment:

```bash
`git commit --allow-empty -m "redeploy" && git push <branch name>`
git commit --allow-empty -m "redeploy" && git push <branch name>
```

The new user cannot access the environment until it is successfully built and deployed.
Loading

0 comments on commit a8a8148

Please sign in to comment.