Note: Some links in this issue summary require user name / password of drupal/drupal to access the site

Task for this issue

In testing, testers were confused about Drush commands and whether they needed to run them.

To mitigate this:

  1. Throughout the guide, wherever a Drush command is given in a topic, it needs to be preceded by some text that indicates that this is an optional alternative. Something like:
    If you prefer to use Drush....
  2. In the Site Prerequisites for any topic that includes Drush commands, it should say something like:
    If you prefer to use Drush instead of the administrative interface,
you will need to have Drush installed. See <<install-tools>> for more information.
  3. In the install-tools.txt file, rewrite or add text to the Drush section so that it makes it clear that Drush commands are an alternative to doing administrative tasks using the administrative user interface, and that you would need to install Drush on the server where your site is running, and have command-line access to that server, in order to use Drush.

Instructions

See https://userguide_new-drupal.dev.devdrupal.org/guidelines/instructions.h... -- but skip the section on finding a task to do, since you have selected this one.

Checklist for this task

- Is a patch file provided? If only one or a few topics were edited, you can instead attach the updated source file(s).
- Is the edit complete and correct?
- Is the work free from additional edits outside the scope of the provided guidelines or task?
- Is attribution provided? See https://userguide_new-drupal.dev.devdrupal.org/guidelines/guidelines.htm...

CommentFileSizeAuthor
#12 2710959-drush-clarify-12.patch3.43 KBjhodgdon
#10 2710959-drush-clarify-reroll-10.patch10.05 KBjhodgdon
#9 2710959-drush-clarify-reroll.patch12.24 KBjhodgdon
#8 2710959-drush-clarify.patch12.24 KBjhodgdon
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon created an issue. See original summary.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Issue summary: View changes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

Trying to fix link in issue summary

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Issue summary: View changes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Assigned: Unassigned » jhodgdon

I'll take this one on. There's some overlap with #2699037: Copy edit: Site prerequisite section (in my patch for that issue, I fixed at least some of the Site Prerequisites sections on this point), so I'll only do the parts here that are not covered in that patch.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Active » Needs review

Here's a patch. I've standardized how the topics with Drush and UI alternatives are worded, added some information to the install-tools section about Drush, and made sure site prerequisites were updated (except those already in the patch for #2699037: Copy edit: Site prerequisite section).

eojthebrave’s picture

eojthebrave
he/him
Primary language English
Location Minneapolis, MN
CreditAttribution: eojthebrave at Drupalize.Me commented
Status: Needs review » Needs work

It looks like this is missing the patch file. Any chance you've still got a copy of it lying around?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs work » Needs review
FileSize
2710959-drush-clarify.patch12.24 KB

Doh. :)

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
FileSize
2710959-drush-clarify-reroll.patch12.24 KB

Slight reroll after recent commits.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
FileSize
2710959-drush-clarify-reroll-10.patch10.05 KB

Rerolled this again, for changes recently committed to install-dev-making. Also I think I have some duplicates to changes in #2699037: Copy edit: Site prerequisite section so this will conflict but I'll reroll after one of them gets committed. Meanwhile I did notice install-dev-making is a complete duplicate of what is in that other patch, so took that out here. config-install duplicates as well, so took that out too. Others... will just have to reroll.

eojthebrave’s picture

eojthebrave
he/him
Primary language English
Location Minneapolis, MN
CreditAttribution: eojthebrave at Drupalize.Me commented
Status: Needs review » Needs work

I just committed #2699037: Copy edit: Site prerequisite section, and it looks like this is going to need a re-roll now.

And a couple of additional thoughts after reading through the patch.

  1. +++ b/source/en/install-tools.txt
@@ -40,6 +36,33 @@ Devel::
+* Doing administrative tasks using Drush is typically faster and less tedious
+than performing the same tasks through the administrative interface.

    I think it might also be worth mentioning that Drush is also a Unix scripting interface for Drupal, and as such it allows you to automate common tasks in ways that would be hard to achieve via the UI. Efficiency++

    To me, this is one of the biggest benefits of a tool like Drush. 

  2. +++ b/source/en/install-tools.txt
@@ -40,6 +36,33 @@ Devel::
+* The administrative interface does not link to all the tasks that Drush
+provides; for example, Drush provides access to database queries, which you
+cannot perform directly in the administrative interface.

    I think this could be re-phrased, and a little shorter. Right now it just reads a little weird to be. Specifcally, "does not link to all the tasks". The "link to" is throwing me off. Anyway, maybe something like, "Drush provides additional functionality not available via the administrative interface. For example, running database queries."

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs work » Needs review
FileSize
2710959-drush-clarify-12.patch3.43 KB

Excellent suggestions!

I checked through the patch carefully, and it looks like nearly all of this patch was duplicated in the prerequisites issue whose patch you just committed. Whoops! At least I was consistent. ;)

So, here's a much smaller patch, with fixes for the suggestions you made in #11.

  • eojthebrave committed b02b121 on 8.x-0.x authored by jhodgdon 
    Issue #2710959 by jhodgdon: Content edit: Clarify that Drush commands...
eojthebrave’s picture

eojthebrave
he/him
Primary language English
Location Minneapolis, MN
CreditAttribution: eojthebrave at Drupalize.Me commented
Status: Needs review » Fixed

Love it! Thanks Jennifer. I've gone ahead and committed this. I also added an attribution for you to install-tools since you made a pretty significant edit here.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

Making another commit on this -- somehow, the What is special about Drush? Section got added twice to the install-tools topic (possibly my fault from another issue, who knows). Anyway, I made sure the latest version was kept. ;)

  • jhodgdon committed 06880c2 on 8.x-0.x 
    Issue #2710959 by jhodgdon: remove duplicate section about Drush that...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.