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

Change README file to better help users with available commands #208

Closed
stpaultim opened this issue Nov 24, 2019 · 13 comments
Closed

Change README file to better help users with available commands #208

stpaultim opened this issue Nov 24, 2019 · 13 comments

Comments

@stpaultim
Copy link
Member

I am one of those "developers" that seldom uses the help option for commands when using the CLI. I should make better use of this resource, but in the past as I was getting started, this page often just confused me.

I tend to look at the list of available commands on the README file for drush and forget that there are apparently many more commands supported.

I think it would be great if we kept a full list of commands in the README file, but at a minimum I am going to suggest a clear adding a clear instruction to users to check the help page for more options.

I will submit a PR to this effect (and it will include adding two more favorites of mine to the README, without being comprehensive). I would be happy for someone to edit this PR or write a new one. Also, I will be happy to revise this PR based upon feedback.

@stpaultim
Copy link
Member Author

stpaultim commented Nov 24, 2019

I just submitted #209

But, in looking closer at drush help - it would appear that it is still listing many Drupal specific commands that may or may not work with Backdrop. Do I understand that correct?

Should we just try and keep the README up to date?

If so, what other commands should be listed?

@serundeputy
Copy link
Member

bcex, bcim, bp, dlb, en, dis, pml

@serundeputy
Copy link
Member

ctl

@stpaultim
Copy link
Member Author

@serundeputy - What is ctl. It didn't work for me and drush ctl --help gave me nothing.

@stpaultim
Copy link
Member Author

I've updated the PR with all suggestions except ctl and reorganized them in groupings/order that make sense to me (the best criteria), happy to hear feedback on alternative organization of the list.

@serundeputy
Copy link
Member

You want drush help ctl

@serundeputy
Copy link
Member

ctl is only available in >= 1.1.0

@stpaultim
Copy link
Member Author

So, I'm working with Lando and the following default recipe:

name: demo
recipe: backdrop
config:
  webroot: .

How do I tell it to use Drush 1.1.0?

@serundeputy
Copy link
Member

I think pmu works too

@serundeputy
Copy link
Member

In the config section add

backdrush: 1.1.0

@stpaultim
Copy link
Member Author

Thanks. I had to destroy and restart lando environment (rebuild did not work). But, I got it working.

@stpaultim
Copy link
Member Author

OK, finally finished making a change before you managed to suggest another addition! ;-)
Done for tonight. See updated PR.

@serundeputy
Copy link
Member

merged: #209
thanks @stpaultim !

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