I think we should consider renaming the user guide, as shown here https://www.drupal.org/docs/user_guide/en/index.html, to "Drupal User Guide", and drop the 8 from the title. My understanding is that the published version of the guide tracks the current release of Drupal. And when 8.9/9 come out the guide will be equally valid for both. So removing the "8" helps make it clear that the guide also applies to 9.0.

It looks like the link in the right column menu on pages like this one https://www.drupal.org/docs already refer to the guide as "Drupal User Guide".

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

eojthebrave created an issue. See original summary.

jhodgdon’s picture

Yes we definitely should do that. I did a grep and I think we need to fix the following files:
- guide.txt (where the book title is located)
- understanding-themes has some text that mentions Drupal 8

There are also a lot of URLs with 8 in the URL or 8 in the page title. Many of these pages have been edited and the URLs updated to remove the 8. We have a testurls.php script that can be used to see if URLs are 404 or redirected. I think we should run this in a week or so (some updates are in progress on #3133569: Migrate Drupal 8 & 9 documentation to evergreen format (instead of major version specific) ... there should be a nearly 1-to-1 correspondence between the URLs having an 8 that is redirected, and the page titles changing.

Actually maybe that script could be updated to look at the page title of the page you land on and see if that has changed. I can look into that.

jhodgdon’s picture

Sigh. That script doesn't work any more, because drupal.org has some script-bashing code in place that makes most URLs return a 403 when accessed from a script at that speed. Also, before it decided I was an attacker, it looked like the 8s are still in the URLs, so if we're able to run that at some point, we would need to wait until the URLs with 8 in them are bulk updated on that other issue.

jhodgdon’s picture

I was also locked out of drupal.org for a bit, but that has been fixed. Anyway, I guess we cannot really use that script; I'll put a note at the top of it.

  • jhodgdon committed d7bab0d on 8.x-8.x
    Issue #3138606: add note to testurls script about problems if you...
eojthebrave’s picture

Bummer the script doesn't work. We could add a throttle to it if we know what the rate limit is. Or, just guess. And then let it run for however long it takes I suppose. Or ask @drumm to run it for us.

I also noticed that different languages have handled these links in different ways. Sometimes translating the title of the page being linked too, and sometimes leaving the link text in English. So it would be challenging to script an update for all the translations if we wanted to try and update the text too. Though, it should work fine to script update the URLs since those are the same no matter what language.

jhodgdon’s picture

I talked with @drumm on Slack, and I can get the script temporarily whitelisted at some point. I don't think the URLs have been updated yet.

andypost’s picture

Is the issue should be fixed after release?

jhodgdon’s picture

Not sure what you're asking... We should go ahead and fix this once the URLs on drupal.org have been fixed, or we could make a patch for the title and the text in understanding-themes.txt now and do the URLs a little later.

jhodgdon’s picture

Issue tags: +Translation updates needed
FileSize
984 bytes

Here's a patch for the part that fixes the guide title and understanding-themes.txt in English.

The URLs and page titles for the drupal.org pages will be more work...

jhodgdon’s picture

FileSize
19.04 KB

I did a quick grep, and it looks like there are 159 www.drupal.org URLs that should be looked at to see if they have been redirected or their titles have changed. A few are pages like /documentation that will be quick (didn't change)... I'll see what I can do.

jhodgdon’s picture

FileSize
10.29 KB

It seems like going through these manually is the best option. I found:
- Some links that were easy to fix -- page titles and/or URLs had changed.
- Some URLs that still had /docs/8 on them on drupal.org -- easily fixed by editing the page, checking "automatic alias", and saving (sometimes you have to go up the hierarchy 1 level to get this to work). Then update the User Guide with the new correct URL.
- A couple of links in Additional Resources that were totally useless (removed them).
- A few links whose text didn't follow our standard format of saying "drupal.org community documentation page xyz" -- fixed those.

Here's a patch for the first part of that urls.txt file -- through the install-dev-making file. More to do... probably later this week.
Note: This patch does not include the 2-line patch earlier uploaded.

jhodgdon’s picture

Status: Active » Needs review
FileSize
32.37 KB

OK, here's a patch that:
- Fixes the guide title
- Fixes other mentions of 8 in the text
- Fixes drupal.org documentation URLs and page titles so they all match what is currently on drupal.org
- Makes sure all documentation pages are referenced in the standard way
- In one case, removes an "additional resources" page reference that has no useful information in it

There are still some problems, like additional resources references leading you to outdated or Drupal 7 documentation, but I did not address those.

jhodgdon’s picture

Here's a related issue about Drupal 9 compliance.

eojthebrave’s picture

Thanks for working on this @jhodgdon. I went through the patch and have just a couple of thoughts/questions. I don't think either of them are blockers, but wanted to point this out based on my review. This gets a big thumbs up from me.

  1. +++ b/source/en/block-regions.txt
    @@ -57,10 +57,7 @@ image:images/block-regions-bartik.png["core Bartik theme regions",width="100%"]
    -==== Additional resources
    -
    -* https://www.drupal.org/node/171224[_Drupal.org_ community documentation page "Assigning content to regions"]
    -
    +// ==== Additional resources
    

    I think the relevant Drupal 8/9 page to replace the one that's removed here is probably this one https://www.drupal.org/docs/theming-drupal/adding-regions-to-a-theme

    Do we want to add that instead of removing this link?

  2. +++ b/source/en/security-cron.txt
    @@ -73,9 +73,9 @@ _http://www.example.com/cron/0MgWtfB33FYbbQ5UAC3L0LL3RC0PT3RNUBZILLA0Nf1Re_
    -  * https://www.drupal.org/node/23714[The Cron daemon] (Linux, OS X, Solaris,
    -  BSD)
    -  * https://www.drupal.org/node/31506[Scheduled Tasks] (Windows)
    +  *
    +  https://www.drupal.org/docs/7/setting-up-cron/configuring-cron-jobs-using-the-cron-command[The Cron daemon] (Linux, OS X, Solaris, BSD)
    +  * https://www.drupal.org/docs/7/setting-up-cron-for-drupal/configuring-cron-jobs-with-windows[Scheduled Tasks] (Windows)
    

    This might be fine, but the formatting looks off here. The "*" on one line, and then the link on the following line.

  3. +++ b/source/en/security-update-module.txt
    @@ -109,7 +109,7 @@ video::https://www.youtube-nocookie.com/embed/wxWW-lPQ_Pc[title="Updating a Modu
    -https://www.drupal.org/node/250790[_Drupal.org_ community documentation page "Updating modules"]
    +https://www.drupal.org/docs/7/update/updating-modules[_Drupal.org_ community documentation page "Update modules"]
    

    I would be okay with just removing this link rather than linking to a D7 page. The linked page contains essentially the same content as the user guide page. Just with more words. So it's probably not all that helpful anyway.

    Alternatively, we could add a "manually updating a module" page to the Updating Drupal (https://www.drupal.org/docs/updating-drupal) guide. But that seems like it would be repetative of the content of the user guide page. And maybe better would be to add the relevant user guide pages as related content to the guide.

jhodgdon’s picture

Thanks for the careful review!

On item 1, I don't think we really need to link to a page about how to add regions to a theme, since we are not covering theming in the guide right now? The original reference was "Assigning content to regions" (about block placement)... I didn't think it was at all useful as an additional resource for that page.

item 2 -- does look like the formatting is off. Good catch!

item 3 -- +1 on removing pages that have no additional information

I can make a new patch sometime later...

jhodgdon’s picture

FileSize
32.34 KB
1.46 KB

OK here's a new patch with those two changes for items 2/3 of #15.

jhodgdon’s picture

If we get this patch in, I think we should make a new release for 8.x-8.x (if it still builds OK) and get this deployed to drupal.org, although there are commits coming in from other languages lately, so the build could have problems. I believe drumm has the build running on a test server on a regular basis, so he should be able to tell before we launch an actual deploy or make a release whether it's working or not, if whoever commits this doesn't have the tool chain working. We should also consider making new ebooks.

The next task would be to work on 9.0... for that the first step is usually to run the tests, but I can't do that until
#3147404: Replace mentions of Mayo theme in User Guide
is taken care of.

Sorry, this comment is a bit off-topic for this issue. :)

eojthebrave’s picture

Status: Needs review » Reviewed & tested by the community

Patch in #17 looks good to me. Thanks @jhodgdon. I agree that it would be nice to get these updates deployed and to then start work on a 9.0 branch.

  • jhodgdon committed 8c22741 on 8.x-8.x
    Issue #3138606 by jhodgdon, eojthebrave: Rename guide to "Drupal User...
jhodgdon’s picture

Status: Reviewed & tested by the community » Fixed

Patch committed. I'll email the list.

jhodgdon’s picture

I also (finally) made an 8.x-8.0 release of the User Guide, and uploaded new e-books to https://www.drupal.org/docs/understanding-drupal/user-guide-e-book-downl... -- so I think that closes out the 8.x-8.x branch and we can move on to 9.0.

Given that d.o is moving to semantic versioning, I think we can make the new branch be 9.0.x, corresponding with Drupal Core 9.0.x.

andypost’s picture

Maybe better to use 9.x branch, it expects just 3 releases before 10, and not a lot of changes.
9.x.y numbering is supposed that something will be backported from later branches, not sure it's a case for user guide

jhodgdon’s picture

Generally there are small UI changes between minor versions of Drupal. So we have traditionally had a new branch of the User Guide for each minor version of Drupal, because screenshots and text often have to change.

Status: Fixed » Closed (fixed)

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