Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Document available CLI commands for Sylius #15945

Open
crydotsnake opened this issue Mar 4, 2024 · 2 comments
Open

[DOCS] Document available CLI commands for Sylius #15945

crydotsnake opened this issue Mar 4, 2024 · 2 comments

Comments

@crydotsnake
Copy link
Contributor

crydotsnake commented Mar 4, 2024

Sylius docs version: 1.13

Description

Currently we have 20 CLI commands in the Sylius namespace. But none of them is documented right now on the Sylius documentation.

I would suggest that we document the existing commands in the documentation with a description of what they are for and, if necessary, the required arguments/parameters.

Of course, we could also discuss whether certain commands should not be documented (for whatever reason).

In case you are all fine with my suggestion: Where should we put it in in the docs? 🤔

Available commands

Command Documented Command Description
sylius:cancel-unpaid-orders Removes order that have been unpaid for a configured period. Configuration parameter - sylius_order.order_expiration_period.
sylius:debug:resource Debug resource metadata.
sylius:debug:template-event Debug template events and associated blocks
sylius:fixtures:list Lists available fixtures
sylius:fixtures:load Loads fixtures from given suite
sylius:inform-about-gus Informs about Sylius internal statistical service
sylius:install Installs Sylius in your preferred environment.
sylius:install:assets Installs all Sylius assets.
sylius:install:check-requirements Checks if all Sylius requirements are satisfied.
sylius:install:database Install Sylius database.
sylius:install:jwt-setup Setup JWT token
sylius:install:sample-data Install sample data into Sylius.
sylius:install:setup Sylius configuration setup.
sylius:promotion:generate-coupons Generates coupons for a given promotion
sylius:remove-expired-carts Removes carts that have been idle for a period set in sylius_order.expiration.cart configuration key.
sylius:show-available-plugins Shows official Sylius Plugins
sylius:theme:assets:install Installs themes web assets under a public web directory
sylius:theme:list Shows list of detected themes.
sylius:user:demote Demotes a user by removing a role.
sylius:user:promote Promotes a user by adding roles.

Let me know what you guys think! 🙂

@mbabker
Copy link
Contributor

mbabker commented Mar 5, 2024

This should only focus on commands in the sylius namespace, otherwise you'd be duplicating the documentation from a lot of upstream resources (does Sylius really need to re-document the commands for the various Doctrine integrations?).

@crydotsnake
Copy link
Contributor Author

This should only focus on commands in the sylius namespace, otherwise you'd be duplicating the documentation from a lot of upstream resources (does Sylius really need to re-document the commands for the various Doctrine integrations?).

Good point! I updated the list 🙂.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants