Note: For guidelines and instructions pages linked below, log in with user name / password: drupal/drupal.

Task for this issue

Edit the entire User Guide for the following copy editing guideline(s):

Avoid mentioning specific versions of Drupal, such as Drupal 7, Drupal 8, etc.

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?
- Is the edit for the provided guidelines complete and correct?
- Is the patch free from additional edits outside the scope of the provided guidelines?
- Is attribution provided? See https://userguide_new-drupal.dev.devdrupal.org/guidelines/guidelines.htm...

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

ifrik created an issue. See original summary.

jhodgdon’s picture

Issue summary: View changes
jhodgdon’s picture

I've now centralized instructions for the editing tasks. I'll go ahead and leave the instructions on these issues, but you can also go to
https://userguide_new-drupal.dev.devdrupal.org/guidelines/instructions.h...
(log in with drupal / drupal)
and follow the instructions there (probably more complete).

batigolix’s picture

Assigned: Unassigned » batigolix

Claiming

batigolix’s picture

FileSize
6.38 KB

Here's a patch.

I removed reference to D8 everywhere, except in external links, examples and comments

batigolix’s picture

Status: Active » Needs review
ifrik’s picture

Status: Needs review » Needs work

Thanks batigolix,

I think in some instances we need to keep the reference to Drupal 8 because it refers to some that specifically different to Drupal 7 (such as reference to composer, console or clean urls).

Also the guide is specifically for D8 so it should be the "Drupal 8 User guide"

  1. +++ b/source/en/guide.txt
    @@ -1,5 +1,5 @@
    += Drupal User Guide
    

    I think we need to keep this here because the guide is specific to D8.

  2. +++ b/source/en/install-requirements.txt
    @@ -54,7 +54,7 @@ Microsoft IIS::
    +  Because clean URLs are required in Drupal, you may need to use a
    

    We should keep D8 here as well, because in D7 clean URLs are not required.

  3. +++ b/source/en/install-tools.txt
    @@ -46,7 +46,7 @@ useful for module and theme developers.
    +  generates boilerplate code and interacts with a Drupal site. It can generate
    

    Keep D8 here as well, because console won't work with D7 afaik.

  4. +++ b/source/en/planning-workflow.txt
    @@ -19,7 +19,7 @@ collect information and write content, editors review, edit, ask for changes,
    +In Drupal, content types can have either a Published or an Unpublished flag to
    

    This could be reworded even further to "Content types can either ..."

  5. +++ b/source/en/security-update-core.txt
    @@ -72,7 +72,7 @@ drush dl drupal
    +_.htaccess_, _composer.json_,_autoload.php_, and so on from your Drupal
    

    This is also D8 specific.

jhodgdon’s picture

Actually, I think we can mostly not say 8 anywhere, except in the title of the overall guide (in the guide.txt file). I think we should only mention Drupal 8 specifically in cases where we are talking about the history of Drupal (hypothetically, because we do not have a topic about this in the Guide as it is now).

So, in comment #7...

Point 1 - agreed, let's keep the overall title as Drupal 8 User Guide.

Point 2/3/5 - disagree. I think we should not mention the number 8 in these spots. These will presumably also be true in 9, 10, ... maybe anyway.

Point 4 - Well, yes, we could remove mentions of Drupal there, but we could also do that in the other spots... and we have a separate issue for that.

So. Let's just revert the change to guide.txt and go with that.

ifrik’s picture

Issue tags: +DrupalBCDays
batigolix’s picture

Status: Needs work » Needs review
FileSize
6.05 KB

Thanks ifrik & jhodgdon for reviewing. Here is a new patch.

One could argue that the version number should even be removed from the title of the guide, because in theory (but unlikely) someone could create a Drupal 7 version of the guide. And do we create a new project for D9?

Anyhow, I put the 8 back in the title ... Time for another review.

jhodgdon’s picture

Status: Needs review » Needs work
Issue tags: +Needs reroll

For Drupal 9, I am assuming that we will just make a 9.x-0.x branch of the User Guide. We could also branch to 7.x if we wanted to.

So... We can leave a few references to 8.x around, such as in the title (and for that matter, the cover image). But the idea is to minimize them, so when we do move to 9.x, we will not have to update that in very many places.

Anyway, the patch looks good to me! Except that it doesn't apply any more, due to other commits that happened recently. Much of it failed, actually... Could someone reroll it please?

Also, after (partially) applying this patch, I used "grep" to find places that still had the number 8 in them. I came up with the following pages -- can you check and see if they need updates? [some may be false alarms]
- config-uninstall.txt (referring to Drush -- I think we should say "a compatible version of Drush" or something like that)
- security-update-core.txt [most likely due to the patch not applying, but check anyway please? Maybe needs an update about Drush?]
- understanding-themes.txt [patch apply problem I think?]

Thanks!

jhodgdon’s picture

Issue summary: View changes

Standardizing issue summaries for the editing issues.

batigolix’s picture

Assigned: batigolix » Unassigned

Unassigning in case someone else wants to take over.

metzlerd’s picture

Assigned: Unassigned » metzlerd
metzlerd’s picture

Assigned: metzlerd » Unassigned
Status: Needs work » Needs review
FileSize
3.9 KB

  • eojthebrave committed 065e948 on 8.x-0.x authored by metzlerd
    Issue #2699051 by batigolix, metzlerd: Copy edit:  Avoid mentioning...
eojthebrave’s picture

Status: Needs review » Fixed

Latest patch looks good to me. I've also run a couple of search/regex to make sure there are no missed instances of Drupal\s?[\d] and there aren't any that we need to worry about here.

Thanks @metzlerd, and @batigolix and everyone else for the help getting this tidied up.

Status: Fixed » Closed (fixed)

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