Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
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.
Comment | File | Size | Author |
---|---|---|---|
#10 | 2677942-10.patch | 17.71 KB | batigolix |
#8 | 2677942-8.patch | 17.42 KB | jhodgdon |
#7 | extend-theme-install-download.png | 64.27 KB | batigolix |
#7 | edit-update-install-module-theme-2677942-7.patch | 22.27 KB | batigolix |
#5 | edit-update-install-module-theme-2677942-5.patch | 16.99 KB | batigolix |
Comments
Comment #2
jhodgdonExpanding 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?
Comment #3
batigolixI created an issue for d) #2681623: Write extend-manual-install
Comment #4
batigolixComment #5
batigolixHere's a first stab
Comment #6
jhodgdonLooks 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.
Comment #7
batigolixNew attempt. I hope the patch makes sense. The last changes can be found from line 445 onwards
Comment #8
jhodgdonThanks! 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.
Comment #9
jhodgdonOK, this is looking pretty good! I still have a few suggestions:
Drush should be capitalized.
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.
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+.
The _ characters here should be " instead
Drush should be capitalized.
Let's get rid of this line. See above.
See above. Turn this into a step and put it first.
Can we start this with "Before you start, ..."
Let's use a specific module like _admin_toolbar_ instead of [module].
Again let's turn this into a step, and since this is a module topic, use admin_toolbar instead of boostrap as the example.
See above, let's use bootstrap instead of [theme]
See above, let's turn this into a step.
Comment #10
batigolixThanks for the review. I fixed your remarks.
I used the IDE for creaing the patch, so let's see if it is an improvement ;)
Comment #11
jhodgdonLooks great! Patched the guide, after doing some minor AsciiDoc formatting.