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

Add magento-cloud, bin/magento (Commerce), and update bin/magento (Open Source) in the CLI reference #5642

Merged
merged 13 commits into from
Oct 10, 2019
Merged

Add magento-cloud, bin/magento (Commerce), and update bin/magento (Open Source) in the CLI reference #5642

merged 13 commits into from
Oct 10, 2019

Conversation

dshevtsov
Copy link
Collaborator

@dshevtsov dshevtsov commented Oct 9, 2019 •
edited by meker12
Loading

Purpose of this pull request

This pull request:

  • updates bin/magento reference after new release (updates data and editorial updates to the topic)
  • adds bin/magento reference for Commerce (topic and data)
  • adds magento-cloud reference (topic and data)

This also changes CLI template to be able to render the magento-cloud reference.

Affected DevDocs pages

Additional information

Staging build: 940

whatsnew
Updated the Command-line tools reference:

@dshevtsov dshevtsov added New Topic A major update published as an entirely new document xx2.3.3 Magento 2.3.3 changes 2.2.10 labels Oct 9, 2019
@dshevtsov dshevtsov requested a review from a team October 9, 2019 23:26
@dshevtsov dshevtsov self-assigned this Oct 9, 2019
keharper
keharper approved these changes Oct 10, 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.

Approved for Open Source/Commerce

hguthrie
hguthrie suggested changes Oct 10, 2019
View reviewed changes
Copy link
Contributor

@hguthrie hguthrie left a comment

Choose a reason for hiding this comment

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

Some magento-cloud comments don't quite fit.

guides/v2.2/reference/cli/magento-commerce.md Outdated
Use the ["Add CLI commands"]({{ page.baseurl }}/extension-dev-guide/cli-cmds/cli-add.html) guide to add a custom Magento CLI command.

{: .bs-callout-info }
You can call Magento CLI commands using shortcuts instead of the full command name. For example, you can call `{{ tool }} setup:upgrade` using `{{ tool }} s:up`, `{{ tool }} s:upg`, etc. See [shortcut syntax](https://symfony.com/doc/current/components/console/usage.html#shortcut-syntax) to understand how to use shortcuts with any Magento CLI command.
Copy link
Contributor

Choose a reason for hiding this comment

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

Per the style guide, etc. should be avoided.

guides/v2.2/reference/cli/magento-cloud.md Outdated

{% capture intro %}
{: .bs-callout-info }
You can call Magento CLI commands using shortcuts instead of the full command name. For example, you can call `{{ tool }} setup:upgrade` using `{{ tool }} s:up`, `{{ tool }} s:upg`, etc. See [shortcut syntax](https://symfony.com/doc/current/components/console/usage.html#shortcut-syntax) to understand how to use shortcuts with any Magento CLI command.
Copy link
Contributor

Choose a reason for hiding this comment

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

So Magento Cloud CLI does not have the setup:upgrade call, but you can use the shortcut method in an interesting way. For example, mgc ssh opens a SSH to the remote environment instead of having to type the full magento-cloud environment:ssh command. Shortcuts are in parenthesis in the help and the second and third example of usage.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't see any reason to keep this note then.

Copy link
Contributor

Choose a reason for hiding this comment

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

Or create one for Cloud. I will take a closer look.

@belbiy
Copy link
Contributor

belbiy commented Oct 10, 2019

@dshevtsov , just FYI, found a bug in the generated page:
table-accidental

i think it's because it has the | symbols in it, and markdown parser thinks that it's a table.

@dshevtsov
Copy link
Collaborator Author

Edited notes, fixed the bug.
(Staging build 946)

@dshevtsov dshevtsov requested a review from hguthrie October 10, 2019 20:46
hguthrie
hguthrie approved these changes Oct 10, 2019
View reviewed changes
Copy link
Contributor

@hguthrie hguthrie left a comment

Choose a reason for hiding this comment

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

I'm fine with it. I think you have made it generic enough to share the same template. We can always add some introductory content to the Cloud file later.

@dshevtsov
Copy link
Collaborator Author

running tests

@dshevtsov dshevtsov merged commit 98f27eb into master Oct 10, 2019
@ghost
Copy link

ghost commented Oct 10, 2019

Hi @dshevtsov, 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.

@dshevtsov dshevtsov deleted the ds_upd-magento-cli-ref branch October 18, 2019 20:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@hguthrie hguthrie hguthrie approved these changes

@keharper keharper keharper approved these changes

@meker12 meker12 Awaiting requested review from meker12

@belbiy belbiy Awaiting requested review from belbiy

Assignees

@hguthrie hguthrie

@keharper keharper

@dshevtsov dshevtsov

Labels
New Topic A major update published as an entirely new document xx2.3.3 Magento 2.3.3 changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dshevtsov @belbiy @hguthrie @keharper