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

Converting the Display Magento error report number KB to devdocs #6061

Merged

meker12 merged 3 commits into master from mae-MAGEDOC-4008-display-magento-error

Nov 25, 2019

Contributor

meker12 commented Nov 22, 2019 •

edited

Loading

Purpose of this pull request

This pull request converts this KB article to a DevDoc article: https://support.magento.com/hc/en-us/articles/360018126211

Affected DevDocs pages

http://devdocs.magento.com/guides/v2.3/cloud/cdn/cloud-fastly-custom-response.html#display-magento-error-report-number

whatsnew
Added instructions for displaying the Magento error report number when using the Fastly plugin with Magento. See Display Magento error report number in the Magento Cloud Guide.


          Converting the Display Magento error report number KB to devdocs

a7b0938

meker12 requested a review from dobooth

November 22, 2019 18:49

meker12 self-assigned this

m2-community-project bot added the Progress: review label

meker12 added Internal Dev 2.x New Topic and removed Progress: review labels

hguthrie suggested changes

View reviewed changes

Contributor

hguthrie left a comment

Consistency problems...

guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md Outdated

+                    nslookup gw.{your_region}.magentosite.cloud
+                    ```
+. Add your application domain and IP address to the hosts file on your local machine:

Contributor

hguthrie Nov 22, 2019

We don't use colons at the end of a step, even with a command.
Also, not sure why using "local machine".
We already have a problem keeping consistent between "local workstation" and "local workspace". Need to stick with one of them.

Contributor Author

meker12 Nov 22, 2019 •

edited

Loading

We do use colons at the end of steps, but I noticed that you have been removing them. I think when the step is followed by a command that is carrying out the step, a colon makes sense. I wonder what the style guide says. The style guide doesn't say anything. Google style guide procedure shows colon as recommended in the context of their specific example.

I notice that this convention of using the colon is followed in other DevDoc Guides.

Is your convention for the context of a step followed by a command? As in, no colon needed to a step introducing the command to complete the step.

guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md Outdated

+                    nslookup {your_project_id}.ent.magento.cloud
+                    ```
+                 -  Pro plan users, Integration environment; Starter plan users, all environments:

Contributor

hguthrie Nov 22, 2019

Consistency.
In many other Cloud guide places, we say "For Pro Staging and Production environments..." and "For Started environments and Pro Integration environment..."

m2-community-project bot assigned hguthrie

m2-community-project bot added the Progress: changes requested label

meker12 commented

View reviewed changes

guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md Outdated Show resolved Hide resolved

guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md Outdated

+                    nslookup gw.{your_region}.magentosite.cloud
+                    ```
+. Add your application domain and IP address to the hosts file on your local machine:

Contributor Author

meker12 Nov 22, 2019 •

edited

Loading

We do use colons at the end of steps, but I noticed that you have been removing them. I think when the step is followed by a command that is carrying out the step, a colon makes sense. I wonder what the style guide says. The style guide doesn't say anything. Google style guide procedure shows colon as recommended in the context of their specific example.

I notice that this convention of using the colon is followed in other DevDoc Guides.

Is your convention for the context of a step followed by a command? As in, no colon needed to a step introducing the command to complete the step.

guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md Outdated Show resolved Hide resolved

meker12 commented

View reviewed changes

guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md Outdated Show resolved Hide resolved


          Apply suggestions from code review

1e02bcd

hguthrie approved these changes

View reviewed changes

Contributor

hguthrie left a comment

I use colons after a procedure title, after a phrase like "the following" or "for example", and before a list. I try to keep all steps as a sentence unless there is a leading phrase or a list.


          Merge branch 'master' into mae-MAGEDOC-4008-display-magento-error

cd7757f

Contributor Author

meker12 commented Nov 22, 2019

running tests

meker12 merged commit 1e3c8d7 into master

ghost commented Nov 25, 2019

Hi @meker12, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

m2-community-project bot removed the Progress: changes requested label

meker12 deleted the mae-MAGEDOC-4008-display-magento-error branch

November 25, 2019 18:12

keharper added a commit that referenced this pull request


          Sync master with develop (#6079)

badb632

* Update first-time-setup-import-import.md

* adding new information from stopwords elasticsearch

* settings

* settings

* settings spaces

* settings by MD029

* settings by MD029

* adding variable from github url tree

* adding url variable

* adding fix MD009

* Using the /search endpoint

* Update rest-api.yml

* Update search-endpoint.md

* Update search-endpoint.md

* Updates as per request points

* Symlink for v2.3

* Symlink modification

* Updated repo path

* Update search-endpoint.md

* Fixed double quotes.

* Google 3.0.2 - RN

Initial Draft

* Outline differences between search types and v1/search and v1/products

* Update search-endpoint.md

* Added PHP note

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

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

Accepted approver's suggestion

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

* fixed broken link

* removing variable and remove link for example

* Added JS script name resolution examples

* Fixed incorrect syntax for custom KO checked binding

* Added missing example for i18n Magento binding syntax

* Incorrect reference url fixed

The reference url was pointing to Customer/Api instead of Catalog/Api

* Fixing the LESS snippet syntax

* Added note for ece-tools patch process fix (#6004)

* Added fix for patch process issue introduced
  by version scheme change for 
  security only patches in Magento 2.3.2-p2.

* Updates yml. Delete unused file.

* Fixed typo.

* Linting

* Grammar and formatting

* Trailing space

* Trailing spaces

* Google 3.0.2 updates

release notes, release, compatibility.

* Markdown linting: Enable rule MD036 (emphasis used instead of a header) (#6023)

* Added colons to common psuedo-headers

* Added colons to less common psuedo headers

* Added colons to more less common psuedo headers

* Removed emphasis from captions

* Fixed up links.

* Added note for ece-tools patch process fix (#6004) (#6020)

* Added fix for patch process issue introduced
  by version scheme change for
  security only patches in Magento 2.3.2-p2.

* Corrected RESOURCE_CONFIGURATION merge example (#6005)

* Fixes #6025

* updated compatible versions

added 2.3.3

* Update extensions/google-shopping-ads/release-notes/index.md

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

* Update extensions/google-shopping-ads/release-notes/index.md

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

* Grammar and formatting

* magento/devdocs#: Cloud. Set ADMIN_URL via magneto-cloud command-line tool (#5971)

* magento/devdocs#: Cloud. Set ADMIN_URL via magneto-cloud command line tool

- https://devdocs.magento.com/guides/v2.2/cloud/env/environment-vars_magento.html
- https://devdocs.magento.com/guides/v2.3/cloud/env/environment-vars_magento.html

* magento/devdocs#: Cloud. Set ADMIN_URL via magneto-cloud command line tool

* Update rake build:prod

Add init task to prerequisites.

* Adding question mark when nullable value is declared

* Adding nullable param question mark in v2.2

* #5632: Incorrect link to JSCS site.

https://devdocs.magento.com/guides/v2.2/coding-standards/code-standard-javascript.html
https://devdocs.magento.com/guides/v2.3/coding-standards/code-standard-javascript.html

* Updated What's New with changes since November 4 (#6030)

* Updated What's New with changes since November 4

* Merge UI component PRs (#6041)

* Update Paging UI component documentation (#6039)

* Update Paging UI component documentation

* Grammar updates

* Update DragAndDrop UI component documentation (#6038)

* Update DragAndDrop UI component documentation

* Grammar updates

* Update date column UI component documentation (#6037)

* Update date column UI component documentation

* Grammar update

* Update ui columns documentation (#6036)

* Update ui columns documentation

* Adjust the example title

* Grammar updates

* Update UI column component documentation (#6034)

* Update UI column component documentation

* Update ui-column.md

* fixed linting error

* removing Google 3.0.2 info

will republish when 3.0.2 is released.

* update whatsnew

remove google 3.0.2 release notes from whatsnew

* magento/devdocs#: Add customerOrders query API errors

- https://devdocs.magento.com/guides/v2.3/graphql/queries/customer-orders.html

* magento/devdocs#: Add customerDownloadableProducts query API errors

- https://devdocs.magento.com/guides/v2.3/graphql/queries/customer-downloadable-products.html

* Optimized Index Management screen capture (#6050)

* Updated Architecture topic for Starter plan (#6043)

Per @jefflathan1:  Starter stores are not entitled to TAms in the same way that Pro stores are. We need to remove the Technical Account Manager entry for Starter, leaving it blank.

* #5218: Need info about structures in Adding a custom indexer (#6042)

* #5218:  Need info about structures in Adding a custom indexer

https://devdocs.magento.com/guides/v2.2/extension-dev-guide/indexing-custom.html
https://devdocs.magento.com/guides/v2.3/extension-dev-guide/indexing-custom.html

* Grammar updates

@atwixfirster I made many grammatical changes. Please review my changes, especially the `shared_index`  description,

* Updating Fieldset UiComponent documentation (#6045)

* Adding the Fieldset UiComponent additional information

* Updating the example

* Minor adjustments

* Update ui-fieldset.md

* Update view-models.md

I wasn't closing a tag page

* GraphQL caching with Fastly (#6031)

* GraphQL caching with Fastly

* Update guides/v2.3/graphql/caching.md

Co-Authored-By: Margaret Eker <meker@adobe.com>

* Added steps to check Fastly version on Cloud

* Fixed syntax

* Apply suggestions from code review

* Editorial fixes

* Apply suggestions from code review

Co-Authored-By: Margaret Eker <meker@adobe.com>

* Delete space at end of sentence

* Update caching.md

* GraphQL: small changes (#6052)

* removing cloud bi from toc

* Editorial fix (#6054)

* GraphQL caching with Fastly

* Update guides/v2.3/graphql/caching.md

Co-Authored-By: Margaret Eker <meker@adobe.com>

* Added steps to check Fastly version on Cloud

* Fixed syntax

* Apply suggestions from code review

* Editorial fixes

* Apply suggestions from code review

Co-Authored-By: Margaret Eker <meker@adobe.com>

* Delete space at end of sentence

* Update caching.md

* Editorial fix

* Add MBI to search and update site switcher (#6062)

* KB migration: Restore an environment (#6063)

* Added new topic and TOC entry

* Added files

* Added optimized images

* Fixed markdown

* Rewrote content

* Fixed links

* Fixed MD errors

* Added xref to new topic

* Fixed xref

* Apply suggestions from code review

Co-Authored-By: hguthrie <hguthrie@users.noreply.github.com>

* Revised per peer review

* Missed a var

* Apply suggestions from code review

Co-Authored-By: Margaret Eker <meker@adobe.com>

* Fixed incorrect terminology and added references

* Converting the Display Magento error report number KB to devdocs (#6061)

* Converting the Display Magento error report number KB to devdocs

* ElasticSearch: Nigix proxy config correction

* Set warning for STATIC_CONTENT_SYMLINK variable (#6065)

* Add STATIC_CONTENT_SYMLINK removal note

* Remove ece-version tool

* Add additional note

* Add supported service versions of RabbitMQ

From the platform.sh docs https://docs.platform.sh/configuration/services/rabbitmq.html

* Updating cli documentation

* Add link to supported version list

* Remove remote_markdown completely

* Fix site variable

* Add example for local RabbitMQ Management UI

* Little changes

* Update guides/v2.2/mtf/configuration.md

Editorial fix

Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com>

* Update guides/v2.2/mtf/configuration.md

Editorial fix

Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com>

* Update guides/v2.2/mtf/configuration.md

Editorial fix

Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com>

* Update guides/v2.2/mtf/mtf_entities/mtf_handler.md

Editorial fix

Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com>

* Fix style

* Small formatting change.

* Resolve code quotation error. (#6072)

* Add docs for new Adobe-generated alert policies for New Relic (#6075)

- Updated New Relic topic to add Adobe-generated alert policies
- Added information about New Relic monitoring to the
following topics: Architecture, and Go Live checklist
- Added new Monitor Performance topic to Manage Project section
- Added images for New Relic alert policies and project credentials

* fix linting error

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

2.x Internal Dev New Topic