As discussed in #2541640: Write security-update-theme.txt the security-update-module topic is rather lengthy. It can be more concise like proposed in this security-update-theme topic #2541640: Write security-update-theme.txt.

More generally this is an issue occurring in 4 topics:

  • extend-module-install
  • extend-theme-install
  • security-update-module
  • security-update-theme

We should ensure the common parts of the topic are similar.

Also link to maintenance mode topic can be included.

We should only cover the two basic ways to download/update: (1) Drush and (2) UI using the Update Manager to download/unpack the files.

We should make sure that all of these use common formatting/language.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

batigolix created an issue. See original summary.

jhodgdon’s picture

Title: Edit security-update-module » Edit update/install module/theme topics

Expanding the scope of this issue a bit, so it covers all of the download/install/update topics for modules and themes. So we're talking about extend-module-install, extend-theme-install, security-update-module, security-update-theme

a) We have a new extend-maintenance topic about putting the site into maintenance mode. We should refer to that in all of these topics. (And are there any others that should refer to this too?)

b) We should only cover the two basic ways to download/update: (1) Drush and (2) UI using the Update Manager to download/unpack the files.

c) We should make sure that all of these use common formatting/language.

d) We should have a separate topic that explains how to download/unpack/upload files if the Update Manager is not working right or if you want to do it manually for some reason (for instance, if you are creating a custom theme or module). This should go into the "Extending and Customizing Your Site" chapter, probably right after the "Downloading and Installing a Theme from Drupal.org" topic. All four of our install/update topics should also link to this topic in Follow-on tasks. This topic should describe where the files should go, where to get them if you're downloading from Drupal.org (get the zip or tar.gz and unzip it).

So let's see.
File name: extend-manual-install
Topic title: Manually installing module or theme files

I've added this to the spreadsheet.

Thoughts?

batigolix’s picture

I created an issue for d) #2681623: Write extend-manual-install

batigolix’s picture

Issue summary: View changes
batigolix’s picture

Status: Active » Needs review
FileSize
16.99 KB

Here's a first stab

jhodgdon’s picture

Status: Needs review » Needs work

Looks good!

A few notes:

a) I agree we should have a screen shot for finding the .tar.gz link in extend-theme-install.txt. Can you add that?

b) Do you think we need to explain what "drupal.org project name" means, and how to find this from the URL of the project page? I think it would be a good idea, for the topics that use that terminology in the Drush steps.

c) In security-update-module.txt... now the first step doesn't start with a . any more, which make sense given the new headings. But maybe the paragraph should start with something like "Before you start, ..." ?

d) Let's make maintenance mode mandatory in security-update-core.txt, so later on don't say "in case you put it into maintenance mode" in that later step.

batigolix’s picture

Status: Needs work » Needs review
FileSize
22.27 KB
64.27 KB

New attempt. I hope the patch makes sense. The last changes can be found from line 445 onwards

jhodgdon’s picture

FileSize
17.42 KB

Thanks! So, this patch file is weird -- it has several of the files in it twice. I couldn't read it as it was, so I applied it and made a new patch file. Attaching this and then I'll review it.

jhodgdon’s picture

Status: Needs review » Needs work

OK, this is looking pretty good! I still have a few suggestions:

  1. +++ b/source/en/extend-module-install.txt
    @@ -58,6 +71,25 @@ are being downloaded to the _modules_ folder.
    +===== Using drush
    

    Drush should be capitalized.

  2. +++ b/source/en/extend-module-install.txt
    @@ -58,6 +71,25 @@ are being downloaded to the _modules_ folder.
    +
    +If you have Drush, you can install a module from the command line.
    

    Let's get rid of this line. We didn't start the "Using the web site" section with a line like this, and I don't think this section needs it either.

  3. +++ b/source/en/extend-module-install.txt
    @@ -58,6 +71,25 @@ are being downloaded to the _modules_ folder.
    +You can find the project name in the second argument of the project
    +url. For example in https://www.drupal.org/project/bootstrap the project name is
    +_bootstrap_.
    

    Bootstrap is a theme, so can we use admin_toolbar as the example here?

    Also, let's make this a step, and put it before the "Run the _dl_..." step that is currently first.

    And I'm not sure "argument" is the right term to use here...

    So I think this should say something like:

    . Find the project name for the module you want to install, which is the last segment of the module's project page URL. For example, if the project URL is _https://www.drupal.org/project/admin_toolbar_, the project name is +admin_toolbar+.

  4. +++ b/source/en/extend-theme-install.txt
    @@ -15,70 +15,91 @@ Download and install a theme from Drupal.org.
    +image:images/extend-theme-install-download.png[_Downloading a theme using a URL_,width=_100%_]
    

    The _ characters here should be " instead

  5. +++ b/source/en/extend-theme-install.txt
    @@ -15,70 +15,91 @@ Download and install a theme from Drupal.org.
    +===== Using drush
    

    Drush should be capitalized.

  6. +++ b/source/en/extend-theme-install.txt
    @@ -15,70 +15,91 @@ Download and install a theme from Drupal.org.
    +If you have Drush, you can install a theme from the command line.
    

    Let's get rid of this line. See above.

  7. +++ b/source/en/extend-theme-install.txt
    @@ -15,70 +15,91 @@ Download and install a theme from Drupal.org.
    +You can find the project name in the second argument of the project
    +url. For example in https://www.drupal.org/project/bootstrap the project name is
    +_bootstrap_.
    

    See above. Turn this into a step and put it first.

  8. +++ b/source/en/security-update-module.txt
    @@ -18,76 +18,88 @@ are announced.
    +Check for module-specific update instructions. This is typically necessary
    

    Can we start this with "Before you start, ..."

  9. +++ b/source/en/security-update-module.txt
    @@ -18,76 +18,88 @@ are announced.
    +. Run the _up_ command from a command prompt, where [module] is the drupal.org
    +project name of the module:
    +
    +----
    +drush up [module]
    

    Let's use a specific module like _admin_toolbar_ instead of [module].

  10. +++ b/source/en/security-update-module.txt
    @@ -18,76 +18,88 @@ are announced.
    +You can find the project name in the second argument of the project
    +url. For example in https://www.drupal.org/project/bootstrap the project name is
    +_bootstrap_.
    

    Again let's turn this into a step, and since this is a module topic, use admin_toolbar instead of boostrap as the example.

  11. +++ b/source/en/security-update-theme.txt
    @@ -69,24 +69,31 @@ image:images/security-update-theme-updates.png["Available updates",width="100%"]
     . Run the _up_ command from a command prompt, where [theme] is the drupal.org
     project name of the theme:
    

    See above, let's use bootstrap instead of [theme]

  12. +++ b/source/en/security-update-theme.txt
    @@ -69,24 +69,31 @@ image:images/security-update-theme-updates.png["Available updates",width="100%"]
    +You can find the project name in the second argument of the project
    +url. For example in https://www.drupal.org/project/bootstrap the project name is
    +_bootstrap_.
    

    See above, let's turn this into a step.

batigolix’s picture

Status: Needs work » Needs review
FileSize
17.71 KB

Thanks for the review. I fixed your remarks.

I used the IDE for creaing the patch, so let's see if it is an improvement ;)

jhodgdon’s picture

Status: Needs review » Fixed

Looks great! Patched the guide, after doing some minor AsciiDoc formatting.

  • jhodgdon committed b597c85 on 8.x-0.x authored by batigolix
    Issue #2677942 by batigolix: Edit update/install module/theme topics
    

Status: Fixed » Closed (fixed)

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