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

Updated manage message queues instructions #5867

Merged
merged 16 commits into from
Nov 6, 2019
Merged

Updated manage message queues instructions #5867

merged 16 commits into from
Nov 6, 2019

Conversation

@meker12
Copy link
Contributor

@meker12 meker12 commented Oct 29, 2019

Purpose of this pull request

Updates to message queue information for Bulk API:

  • Clarify note about starting the async.operations.all consumer that handles asynchronous and bulk API messages.
  • Add prerequisite to install and configure RabbitMQ before using Bulk API

Affected DevDocs pages

@meker12 meker12 added 2.2.x 2.3.x Magento 2.3 related changes Technical Updates to the code or processes that alter the technical content of the doc partners-contribution PR created by Magento partner Partner: Trezo labels Oct 29, 2019
@meker12 meker12 requested review from hostep and nuzil October 29, 2019 04:17
hostep
hostep reviewed Oct 29, 2019
View reviewed changes
Copy link
Contributor

@hostep hostep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @meker12, looks good at first sight!

I would however also remove the very first paragraph on https://devdocs.magento.com/guides/v2.3/config-guide/mq/manage-message-queues.html:

If you don’t want to implement the RabbitMQ solution, you can manage message queues with cron jobs (or an external process manager) and the command line to ensure that consumers are retrieving messages.

As that's not correct and might cause confusion, it implies you can use RabbitMQ standalone without consumers running, which isn't true.

@meker12 meker12 mentioned this pull request Oct 29, 2019
Closed
@meker12 meker12 requested a review from keharper October 29, 2019 21:26
@nuzil nuzil self-assigned this Oct 29, 2019
keharper
keharper suggested changes Oct 29, 2019
View reviewed changes
Copy link
Contributor

@keharper keharper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to fix the linking strategy.

guides/v2.3/install-gde/prereq/install-rabbitmq.md Outdated

{:.bs-callout .bs-callout-info"}
A basic message queue system can be implemented using cron instead of RabbitMQ. See [Configure message queues]({{page.baseurl}}/config-guide/mq/manage-mysql.html) for more information.
You can use MySQL or RabbitMQ for message queue processing. For details on setting up the message queue system, see [Message queues overview]({{ page.baseurl }}/extension-dev-guide/message-queues/message-queues.html). If you are using the Bulk API with {{ site.data.var.ee }} v2.3.3 or later, the message queue system configuration defaults to using RabbitMQ as the message broker. See [Start message queue consumers]({{page.baseurl}}/config-guide/mq/manage-message-queues.html#start-message-queue-consumers) for more information.
Copy link
Contributor

@keharper keharper Oct 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See hostep's comment above.

nuzil
nuzil suggested changes Oct 30, 2019
View reviewed changes
Copy link
Contributor

@nuzil nuzil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically if fix complains, will look good for me

@meker12
- Fixed hard-coded link
4b908ac 
- Removed confusing statement about managing
message queues using cron jobs
- Added note and link about configuring consumers_runner
job on Cloud
@meker12 meker12 requested review from hostep and keharper October 31, 2019 17:19
@webmaster-sfs webmaster-sfs mentioned this pull request Oct 31, 2019
Closed
@nuzil
Copy link
Contributor

nuzil commented Oct 31, 2019

Can you please sync branch with master?

meker12
meker12 commented Nov 4, 2019
View reviewed changes
meker12
meker12 commented Nov 4, 2019
View reviewed changes
guides/v2.3/install-gde/prereq/install-rabbitmq.md

{:.bs-callout .bs-callout-info"}
A basic message queue system can be implemented using cron instead of RabbitMQ. See [Configure message queues]({{page.baseurl}}/config-guide/mq/manage-mysql.html) for more information.
You can use MySQL or RabbitMQ for message queue processing. For details on setting up the message queue system, see [Message queues overview]({{ page.baseurl }}/extension-dev-guide/message-queues/message-queues.html). If you are using the Bulk API with {{ site.data.var.ee }}, the message queue system configuration defaults to using RabbitMQ as the message broker. See [Start message queue consumers]({{page.baseurl}}/config-guide/mq/manage-message-queues.html#start-message-queue-consumers) for more information.
Copy link
Contributor Author

@meker12 meker12 Nov 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can use MySQL or RabbitMQ for message queue processing. For details on setting up the message queue system, see [Message queues overview]({{ page.baseurl }}/extension-dev-guide/message-queues/message-queues.html). If you are using the Bulk API with {{ site.data.var.ee }}, the message queue system configuration defaults to using RabbitMQ as the message broker. See [Start message queue consumers]({{page.baseurl}}/config-guide/mq/manage-message-queues.html#start-message-queue-consumers) for more information.
You can use MySQL or RabbitMQ for message queue processing. For details on setting up the message queue system, see [Message queues overview]({{ page.baseurl }}/extension-dev-guide/message-queues/message-queues.html). If you are using the Bulk API with {{ site.data.var.ee }}, the message queue system configuration defaults to using RabbitMQ as the message broker. See [Start message queue consumers]({{page.baseurl}}/config-guide/mq/manage-message-queues.html#start-message-queue-consumers) for more information.

@meker12 meker12 marked this pull request as ready for review November 4, 2019 23:09
@meker12
Copy link
Contributor Author

meker12 commented Nov 4, 2019

running tests

@meker12
Fixed broken link
a966539 
Changed _Start consumers_ topic title to
_Start message queue consumers_ for consistency
with v2.3
meker12
meker12 commented Nov 6, 2019
View reviewed changes
Copy link
Contributor Author

@meker12 meker12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed unneeded link which was breaking the build.

@meker12
Copy link
Contributor Author

meker12 commented Nov 6, 2019

running tests

@meker12 meker12 merged commit b115b05 into master Nov 6, 2019
@ghost
Copy link

ghost commented Nov 6, 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.

@meker12 meker12 deleted the mae-add-manage-message-queues-instructions branch November 7, 2019 17:18
keharper added a commit that referenced this pull request Nov 11, 2019
@keharper
Sync develop with master (#5970)
2b5f111 
* Update the UI Date component documentation

* Update xml-instructions.md

 Adding alternative magic method to retrieve arguments

* Remove empty line

* Adding changes to 2.2 too

* Update adding-attributes.md

Fix name of method to plug into and clarify return type notation.

* Fix fenced code block language type

* Use JavaScript for fenced code block language

* Add newline before fenced code block

I hope this will make the linter happy

* Combine get method examples

* Added translation methods in UI component templates

* magento/devdocs#: Fix link on the “Magento payment provider gateway” page

https://devdocs.magento.com/guides/v2.2/payments-integrations/payment-gateway/payment-gateway-intro.html
https://devdocs.magento.com/guides/v2.3/payments-integrations/payment-gateway/payment-gateway-intro.html

* Reorganized templates topic

* Fixed symbolic link creation command

* magento/devdocs#: Add revokeCustomerToken mutation API errors

- https://devdocs.magento.com/guides/v2.3/graphql/mutations/revoke-customer-token.html

* EQP updates (#5918)

* set up EQP integration branch

* Update api.md

* Update auth.md

* Update auth.md

* Small formatting changes

* Decapitalized headers

* Small formatting changes

* Update files.md

* Grammar and formatting

* Add new file filtering.md

* Add filtering to the index

* Fix broken link

* Update packages.md

* Update packages.md

* Grammar and formatting

* Editorial pass

* Users.md (#5909)

* Update users.md

* Update users.md

* Update users.md

* Update users.md

* Update users.md

* Update users.md (#5915)

* Update users.md

* Update users.md

* Update filters.md

* linting corrections

* add bogus file to resolve merge conflict

* still resolving merge conflict

* deleted file again

* Revert "linting corrections"

This reverts commit c84d489.

* linting errors

* adding file again

* delete phantom file

* Apply suggestions from code review

Incorporating review comments. The line breaks are permitted, as developers may have IDE settings that are different than settings a writer typically uses.

Co-Authored-By: Jeff Matthews <matthews.jeffery@gmail.com>

* Fixed cms query input (#5920)

* Grammar and formatting

* magento/devdocs#: Add createEmptyCart mutation API errors (#5881)

- https://devdocs.magento.com/guides/v2.3/graphql/mutations/create-empty-cart.html

* Replace jquery/ui usages with individual jQuery UI components (#5923)

* Replace jquery/ui usages with individual jQuery UI components

* Update custom_js.md

* Update js_practice.md

* Update custom_js.md

Correcting linting error

* Updated what's new (#5922)

* Updated what's new

* Apply suggestions from code review

* Added guidance for fixing session start (#5877)

* Added guidance for fixing session start
failures when launching Magento cloud
Docker on Windows environment

* Fixed note indentation

* Restored substep formatting

* Add attributes to ProductFilterInput

* Added attribution for contributor

* Update the documentation for ActionDelete UI component documentation

* Removed space

* Changed subheadings hierarchy level

* magento/devdocs#: Add addConfigurableProductsToCart mutation API errors

https://devdocs.magento.com/guides/v2.3/graphql/mutations/add-configurable-products.html

* Update ActionsColumns UI component

* Update Bookmarks UI component documentation

* magento/devdocs#: Add addVirtualProductsToCart mutation API errors

https://devdocs.magento.com/guides/v2.3/graphql/mutations/add-virtual-products.html

* Update ColumnsControls UI component documentation

* Adjusted the ActionsColumns component documentation

* Adjusted the ui bookmarks UI component documentation

* Fixed Examples title

* Fixed Examples title

* Fixed Examples title

* Adjusted the ActionDelete component documentation

* Grammar and formatting

* Small update

* magento/devdocs#: Add addSimpleProductsToCart mutation API errors

- https://devdocs.magento.com/guides/v2.3/graphql/mutations/add-simple-products.html

* Update Search UI component documentation

* Fixed grammar

* Added instructions for Fastly Edge Modules: Reroute to other CMS backend (#5865)

* Added instructions for using Fastly Edge Modules to reroute requests to another backend
* Updated based on review feedback
- Changed title
- Added separate "Prerequisites" section
- Cleaned up introduction and configuration procedure

* Updated manage message queues instructions (#5867)

- Inserted Manage message queues instructions to enable bulk API message processing
- Added prerequisite for RabbitMQ install
- Removed confusing statement about managing
message queues using cron jobs
- Added note and link about configuring consumers_runner
job on Cloud
Changed _Start consumers_ topic title to
_Start message queue consumers_ for consistency
with v2.3
- Removed unneeded link reference

* Small grammar change

* Small grammar fix

* Small grammar change

* Update add-virtual-products.md

Edited for grammar.

* Update add-simple-products.md

Grammatical changes

* Update add-configurable-products.md

Grammatical edits

* Update revoke-customer-token.md

* Small grammar update

* magento/devdocs#: Add addVirtualProductsToCart mutation API errors

* Enhance Commerce release info (#5953)

* Added security patches

* Removed shipping

* Editorial changes

* Added disclaimer

* Removed PWA qualification

* Removed shipping from compatibility table

* Removed Page Builder

* Markdown linting: Enable rule MD032 (lists should be surrounded by blank lines) (#5957)

* Fixed all obvious errors

* Fixed false positives

* Fix endpoint domain names

* Update MFTF datafile.

* Update migration-troubleshooting.md

Fix error in XML, ignore field should be added to <field_rules> node

* Fix the mdl version to 0.7.0 in the GH workflow

* magento/devdocs#: Add createCustomer mutation API errors (#5961)

* magento/devdocs#: Add createCustomer mutation API errors

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

* Update create-customer.md
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

3 more reviewers

@nuzil nuzil nuzil approved these changes

@hostep hostep hostep approved these changes

@keharper keharper keharper approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@nuzil nuzil

@meker12 meker12

@keharper keharper

Labels

2.2.x 2.3.x Magento 2.3 related changes Partner: Trezo partners-contribution PR created by Magento partner Technical Updates to the code or processes that alter the technical content of the doc

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@meker12 @nuzil @hostep @keharper @brunoroeder @dobooth