Closed (fixed)
Project:
User Guide
Version:
8.x-3.x-dev
Component:
Project management
Priority:
Normal
Category:
Task
Assigned:
Reporter:
Created:
2 Mar 2017 at 00:06 UTC
Updated:
7 Jul 2017 at 21:39 UTC
Jump to comment: Most recent
Problem/Motivation
The User Guide needs a new branch and release, 8.x-3.x, to correspond with Drupal Core 8.3.x.
Proposed resolution
Make a new branch, and update text and screenshots as necessary.
Remaining tasks
* [DONE] Make a new 8.x-3.x branch in the Git repository.
* [DONE] Run the screenshots/tests scripts in existing languages:
- Update database dumps.
- Update screenshots that have changed.
- [no updates needed] See if any user interface text or steps in the User Guide need to be updated (hopefully the tests/scripts that generate the screenshots will fail if updates are needed, so we will notice).
[ALL DONE] Languages to test/update:
-- [DONE] English (en)
-- [DONE] Catalan (ca)
-- [DONE] Hungarian (hu)
-- [DONE] Simplified Chinese (zh-hans)
* [DONE] Create screenshots and database dumps for two new languages:
-- [DONE] French (fr): #2837539: FR Screenshots issue
-- [DONE] Japanese (ja): #2885310: [JA] Japanese screenshots
(The other 5 language groups that are translating the User Guide have not yet requested automated screenshots be created and/or provided the text for the Farmer's Market scenario that is used in the screenshots.)
* [DONE] Make an 8.x-3.0 release with e-book output
* [DONE] Get the new 8.x-3.x User Guide deployed to drupal.org
List of 8.3.x changes
Here is a list of topics and screenshot images that needed updates in 8.3.x:
- The tests/scripts required some minor updates for technical behind-the-scenes changes in Drupal.
- Many images had minor changes that didn't affect understanding, but they were updated to reflect the latest Drupal (after verifying the User Guide text didn't need an update).
- A few administrative pages got redesigned in 8.3.x, such as the major redesign of the Status Report page. Other pages had less drastic changes. Nothing required changes to the User Guide text, just updated screenshots.
Original report...
This issue is to remind me that when Drupal core 8.3.0 is released (it's in the Release Candidate phase now), we probably need to make a corresponding 8.x-3.x branch of the User Guide.
Probably some of the UI text has changed. The tests that were added in #2782897: Add more automated tests will catch most changes (but probably not all). So, we should run the automated tests and see if any of them fail, and make updates to the Guide text as needed. We also may need to update some screenshots, correspondingly.
One thing I know changed in 8.3.x from 8.2.x is that the Status Report was redesigned. The tests will not capture that change, but we should make a new screenshot for that topic (in the Preventing and Fixing Problems chapter).
Comments
Comment #2
jhodgdonAdding some notes.
Comment #3
jhodgdonJapanese and French teams both requested screenshots today, so it's time to make a 3.x branch! I'll be working on this in the next few days...
Comment #4
jhodgdonFirst step: I created the 8.x-3.x branch in the Git repository today, and posted a message to the email list about the new branch. I will start on the screenshot updates, as well as Japanese and French screenshots, shortly. In that process, I will also be running the tests to see if any user interface text has changed that would require us to update the User Guide text in English and other languages. I'll post comments here...
Comment #5
jhodgdonUpdating summary with tasks.
Comment #6
jhodgdonComment #7
jhodgdonI'm finding that there are some minor, cosmetic differences in many of the screenshot images, so I'll be saving new versions of them -- I think it's best to have images that match the current Drupal as much as possible. And I had to make a few changes to my tests/scripts.
So, I'll be making some commits as I go, but I won't particularly note minor, cosmetic changes to images, or when I get to the other languages, changes like "There's more of the UI translated, so the image is more Hungarian than it used to be" etc.
Comment #8
jhodgdonComment #13
jhodgdonI got through the English screenshots... mostly minor updates. There were minor redesigns on a few admin pages and a major redesign on the Status Report page, but nothing that I thought needed to be updated in the text, so... on to the other languages, and I can just update the screenshots for them as I go.
I also found a stray image -- security-update-core_statusReport.png that is actually not being used in the User Guide, so I deleted it from all languages.
Comment #16
baluertlI went through all HU images and checked them for any regression (I mean new, unknown issue). Some strings are not translating, which are known issues of l10n_update, so not the fault of this scripts. As counter-testing I also compared these images to CA and ZH-HANS locales as well, here are my results:
images file name, string/observation, (LCs) – quite strange, but not all locales suffers the same problem)
block-create-custom-add-custom-block.png New revision (HU, CA, ZH-HANS)
content-create-create-basic-page.png Hide summary (HU, CA, ZH-HANS)
content-create-create-basic-page.png Revision log message (HU)
content-edit-admin-content.png Hide lower priority columns (HU, CA, ZH-HANS)
preface-conventions-top-menu.png Home (HU, CA, ZH-HANS)
structure-content-type-add-confirmation.png misaligned primary tabs (HU, CA)
structure-content-type-add-Display-settings.png Don't display post information (HU, CA, ZH-HANS)
structure-content-type-add-Menu-settings.png Don't display post information (HU, CA, ZH-HANS)
structure-content-type-add-Publishing-Options.png Don't display post information (HU, CA, ZH-HANS)
structure-content-type-add-submission-form-settings.png Don't display post information (HU, CA, ZH-HANS)
structure-taxonomy-setup-vocabulary-overview.png Show row weights (HU, CA, ZH-HANS)
structure-taxonomy-setup-vocabulary-overview.png No terms available (CA, ZH-HANS)
user-roles_bulk.png Apply to selected items (HU, CA)
user-roles_people-list.png Add the Administrator role to the selected users (HU, CA, ZH-HANS)
views-block_add-block.png Page (HU, CA, ZH-HANS)
views-create-view-output.png character encoding problem (HU)
Comment #17
jhodgdonI have only finished updating images for English. For Hungarian, I have about 3 more batches to do.
I think we already updated the UI text in the User Guide for most of these issues, so it is only the images that need an update?
Comment #19
jhodgdonStill working on Hungarian, should be with that done shortly. I wanted to do one of the langauges that had already been done before starting French and Japanese, so that if something didn't work, I would know whether it was also a problem with the languages that worked before or was a specific problem for the new language... I think I will go ahead and do updates for Catalan and Chinese also, then make the new screenshots for French and Japanese. I should have all of them done in the next few days.
Also, adding two steps to issue summary.
Comment #22
jhodgdonHU is updated. Starting on CA.
Also copied in a bunch of English-only screenshots that are shots of drupal.org download pages to all languages. I had updated them for English yesterday and forgot to copy them to the other languages then. Such as extend-theme-find_search_results.png and security-update-module-release-notes.png and pages like that.
Comment #26
jhodgdonCA is done... probably all for today.
Comment #27
jhodgdonUh oh. I started running Chinese, and realized there was a problem in the basic config chapter for HU and CA. For some reason, when the site name was set in the basic config topic, it didn't work, so for the rest of the test, the site name is showing as "Drupal" instead of the translation of "Anytown Farmers Market". I didn't notice when I was looking at the screenshots for HU and CA, but it was pretty obvious when I was looking at Chinese. Some sort of weirdness in the test script... I'm trying to create a workaround for it... will see what I can do, but I'll need to redo several images and all of the database backups for HU and CA. (For some reason English actually worked, while the others did not, and I don't know why.)
Comment #28
jhodgdonWell, I can reproduce the bug in the test environment, but it doesn't happen on simplytest.me (at least, I tested in Catalan, which has the bug in the test environment and in simplytest.me it works fine). The bug is that even though I have set the site name on the basic site configuration chapter, when you look at the site, it has "Drupal" in the header as the site name.
And for some reason, it is only a problem in non-English languages. ?!?
Anyway... I think rather than trying to actually figure out the reason for the bug or fixing the bug, the easiest thing will be to add a bit of JavaScript to the pages for the screenshots that fixes the text. The screenshot pages already have a lot of JavaScript added to them (that is how they are automatically trimmed down to just show part of the page, etc.), so this is actually easy. It will take me an hour or two to fix the 11 images I have identified as being problems, for HU and CA, and then I can get back to making images for ZH-HANS. And then finally make the new images for FR and JA. Phew! ... Onward!!
Comment #31
jhodgdonUpdate: I got the work-around working for the weird problem in #27/#28 (although I still don't know what is going on), and have updated CA and HU images, plus the 4 images in ZH-HANS for the first four chapters. I'm now taking care of the rest of ZH-HANS images (updating to Drupal 8.3.x plus fixing the remaining problems with the site name).
Once Chinese is done, I'll start on FR and JA.
Comment #33
jhodgdonChinese will be done shortly... Just filed #2887495: Automated screenshots have English in them, which is a new issue I've noticed in this iteration. For now I am proceeding and will look into this later.
Comment #35
jhodgdonChinese is done, starting Japanese (commits will be on the separate issue). Then French (also commits on that issue).
Comment #36
jhodgdonJapanese 3.x screenshots are done.
Comment #38
jhodgdonFrench screenshots are done, and I've added the e-book output to the branch, and made an 8.x-3.0 release (which should be live on the project page shortly, as soon as the drupal.org packaging script runs).
All that remains is to get the import done for drupal.org. Tomorrow!
Comment #39
jhodgdonI've successfully imported the 3.x branch of the User Guide into a development site. As soon as I can find @drumm, I'll see about getting it imported into drupal.org.
Comment #40
jhodgdonThe 3.x version has been imported into drupal.org! Due to image caching that is in place there, some of the screenshots may not look like they are updated for up to the next 24 hours, but some of them are definitely already updated, such as on:
https://www.drupal.org/ca/docs/user_guide/ca/menu-home.html
Also you can see a bunch of new languages there! And the Contributor Guide has some updates for the new translation updates notification process. So, I'm going to go ahead and mark this issue as fixed!