Note: For guidelines and instructions pages linked below, log in with user name / password: drupal/drupal.
The people testing the User Guide found a problem with the language-content-config.txt topic ("Configuring Content Translation").
The problem is that several of the steps are more descriptive (telling you about the settings) than prescriptive (telling you what boxes to check and what settings to choose). The screen shots kind of show what they should be, but the text doesn't tell you "Select this from this select list, and check this box" and things like that.
So the steps need to be rewritten to be more explicit. One step that is definitely missing is that you need to check the box next to "Basic Page" in order for that content type to be translatable. But the whole topic needs a rewrite to be telling you what to do.
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.
- Is a patch file provided? If only one or a few topics were edited, you can instead attach the updated source file(s).
- Is the edit complete and correct?
- Is the work free from additional edits outside the scope of the provided guidelines or task?
- Is attribution provided? See https://userguide_new-drupal.dev.devdrupal.org/guidelines/guidelines.htm...
| Comment | File | Size | Author |
|---|---|---|---|
| #8 | user_guide-language_content_config-2711103-8.patch | 4.81 KB | jojyja |
| #6 | user_guide-language_content_config-2711103-6.patch | 3.36 KB | jojyja |
Comments
Comment #2
jhodgdonComment #3
jhodgdonFixing file name in title and summary.
Comment #4
jhodgdonComment #5
jojyja commentedI'm taking this up.
Comment #6
jojyja commentedHere is the patch
Comment #7
jhodgdonThis is very good, thanks! Much better than what is currently there.
I think it could be made even better with a couple of additions:
a) In step 3, instead of the note that is there about the default language and other settings, can we turn that into a new step? Something like:
Verify the settings for the entity types:
(followed by a table of fields, explanations, and values)
In other topics, that is how we are explaining what values to choose for fields, so this one should do the same.
b) In what is currently step 4, I think we also need a table of fields, explanations, and values for the Basic Page content type. We've lost some information that was in the paragraph about why some fields should be checked and some shouldn't, and a table would be a good way to present that information. Also, this step should start with "Choose" rather than "You can further choose".
If we put this table in, it might make sense to put the "Similarly... for block/menu link" as a separate step?
Thanks!
Comment #8
jojyja commentedThanks for your feedback, Jennifer! I have created a new patch with your input.
Comment #9
jhodgdonThat looks pretty good, thanks! The only thing I'm not sure about is the table of which fields should be translatable. The text of the step (before the table) suggests unchecking some of them:
Many of these fields may not be translation dependent (e.g. Publishing status) in which case it is better to leave them disabled.
But the table has all of them checked.
Also, next time you make a table, a formatting note: we normally don't leave blank lines between the table lines in the AsciiDoc source. I don't think it matters to AsciiDoc, but we should keep the tables consistent with each other in the source.
Anyway... I'll commit this shortly but I might change a couple of the translation fields from Checked to Unchecked, so that they match what the text says.
Thanks!
Comment #10
jhodgdonOn further thought, I think the table is mostly correct... I adjusted the text above slightly. Committing this pretty much as-is, with some formatting updates.
Thanks! With your much appreciated help, we are getting close to finishing this editing phase of the Guide!