This issue is for avanraaphorst, who is working on making more and better entries for the index, following up on #2699833: Copy edit: Index style (which was basic copy editing and consistency).

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon created an issue. See original summary.

avanraaphorst’s picture

Assigned: Unassigned » avanraaphorst

I'm claiming this issue

avanraaphorst’s picture

Status: Active » Needs review
FileSize
8.22 KB

Hi, Jennifer --

I'll be doing this task in several batches (phases) -- this is the first. I changed about 20 files and built the doc locally so I could see the result. I'm now leaning heavily on making (virtually) all of the nouns singular, what do you think?

Please commit as soon as it's convenient -- I'd like to do a new pull before I start the next batch.

Thanks, Anna

jhodgdon’s picture

Status: Needs review » Needs work

Good plan -- I like smaller patches. And I will defer to whatever you think makes sense for the index (singular vs. plural). I don't have a strong opinion, except that we shouldn't have both singular and plural for the same noun in the index.

So... Since this is a multi-stage issue, I went ahead and committed the patch above, since I think it is almost entirely a great improvement! Here are a few review comments that hopefully you can either disagree with in another comment, or fix in your next batch:

  1. +++ b/source/en/config-theme.txt
    @@ -3,6 +3,10 @@
    +(((Previewing settings)))
    

    I'm a bit confused about this index entry... what is it related to in this topic?

  2. +++ b/source/en/config-uninstall.txt
    @@ -2,7 +2,10 @@
    +(((Drush tool)))
    

    I don't think we should have an index entry for just "Drush tool" on this topic. We have Drush commands shown on a number of topics... and this one is not really *about* the Drush tool. So it should probably be [see note below in another topic]:

    (((Drush tool, using to uninstall module)))

  3. +++ b/source/en/config-user.txt
    @@ -3,7 +3,7 @@
    -(((Security,user registration settings)))
    +(((Security,managing user accounts)))
    

    So there are two different things you can do in Drupal:

    a) Manage user accounts -- which means, add new users, block users, change their roles, etc. Not covered in this topic.

    b) Configure the user account settings -- which means, the settings about who can register new users (self-register or admin only), edit the email messages users get when they register or are registered, etc. That is what is covered in this topic.

    So... I do not think we should say (((Security,managing user accounts)))
    for the entry here. This topic doesn't cover managing user accounts, it covers configuring the user account settings properly for security.

    Thoughts?

  4. +++ b/source/en/extend-module-install.txt
    @@ -4,9 +4,13 @@
    +(((Drush tool,using to install and download module)))
    

    This seems like a good index entry for Drush, rather than a generic "Drush tool" one like the note above.

  5. +++ b/source/en/extend-theme-install.txt
    @@ -2,10 +2,21 @@
    +(((Custom theme, downloading and installing)))
    

    I don't think you would "download" a custom theme, since you created it yourself? I think I would just say "installing" here.

avanraaphorst’s picture

Hi Jennifer --

This is phase 2 of probably 3 or 4:
- Corrected suggestions in your response to the phase 1 patch
- Completed the copyedit
- Added index items

I expect to complete the remaining work by Monday, April 25. I'll include my style comments in one of the last two patches.

-Anna

avanraaphorst’s picture

Status: Needs work » Needs review
FileSize
29.89 KB

See above

jhodgdon’s picture

Status: Needs review » Needs work

Looks great ! I committed your phase 2 patch in its entirety.

By the way I will be out of town from this afternoon through next Wednesday, so I apologize in advance that I will not be able to commit any patches until Thursday next week after this one.

A few comments / questions that you may wish to address in the next round:

  1. +++ b/source/en/config-user.txt
    @@ -3,7 +3,7 @@
    -(((Security,managing user accounts)))
    +(((Account setting,configuring)))
    

    I think it makes sense to have an entry under Security of some sort for this topic.

    I think it should probably be:

    (((Security,user account settings)))

  2. +++ b/source/en/extend-module-install.txt
    @@ -4,12 +4,16 @@
    +(((Update Manager module,requirement for installing contributed module)))
    +(((Update Manager module,requirement for installing contributed module)))
    

    Duplicate lines here

  3. +++ b/source/en/extend-theme-install.txt
    @@ -2,18 +2,20 @@
    +(((Update Manager module,using to install Drupal)))
    

    This topic is about installing themes, not about installing Drupal.

    For that matter, you cannot use the Update Manager module to install Drupal. ;)

    I suspect this is just a typo.

  4. +++ b/source/en/language-enable.txt
    @@ -1,8 +1,16 @@
    +(((Module,Language)))
    +(((Module,Content Translation)))
    +(((Module,Configuration Translation)))
    +(((Module,Interface Translation)))
    

    I like these entries. Are you planning to go through the rest of the guide and make sure other modules that are mentioned get similar entries in other topics too?

  5. +++ b/source/en/menu-home.txt
    @@ -2,9 +2,8 @@
    -(((Configuration,front page)))
    

    This entry got dropped, so there is nothing under Configuration any more for this topic. Was that intentional?

  6. +++ b/source/en/menu-link-from-content.txt
    @@ -1,8 +1,9 @@
    +(((Menu,adding a link to page)))
    +(((Page,adding to menu while editing)))
    +(((Content,adding to menu while editing)))
    

    It struck me here that the topic title has the word "Navigation" in it, but there is nothing in the index for this topic under Navigation.

    Would that be useful to add?

  7. +++ b/source/en/planning-data-types.txt
    @@ -1,10 +1,16 @@
    +(((Content type,overview)))
    +(((Comment type,overview)))
    +(((Block type,overview)))
    +(((Vocabulary,overview)))
    

    It might be useful to add Taxonomy term to this list as well? And maybe the other mentioned entity types:
    User profile
    Custom block
    File
    Contact form

  8. +++ b/source/en/planning-modular.txt
    @@ -2,9 +2,9 @@
    -(((Views,and modular content)))
    

    It is probably still useful to have an entry here for the Views module. It is mentioned in the topic (near the end).

  9. +++ b/source/en/security-announce.txt
    @@ -2,7 +2,11 @@
    +(((Update Manager tool,overview)))
    

    Technically Update Manager is a module (not really a "tool" in the sense of what we meant in the Tools topic).

  10. +++ b/source/en/thoughts-connecting.txt
    @@ -3,13 +3,13 @@
    -(((Group,finding)))
    

    Do you think it is useful to have an entry under "group" here? It got dropped.

  11. +++ b/source/en/thoughts-learn-more.txt
    @@ -1,8 +1,9 @@
    +(((Drupal,training resources for)))
    

    I am unsure whether having any entries in the index for "Drupal" makes sense. I am inclined to think it doesn't, because the entire guide is about Drupal. So having a few Drupal entries seems... a bit weird?

  12. +++ b/source/en/understanding-drupal.txt
    @@ -4,7 +4,10 @@
    +(((Drupal content management system,overview)))
    +(((Drupal content management system,server requirements for)))
    +(((Drupal core,overview)))
    

    This is probably an exception to the "no Drupal entries" rule. Maybe the others are too. I will defer to your judgment. :)

  13. +++ b/source/en/views-block.txt
    @@ -2,7 +2,8 @@
    +(((Recipe view,adding block display to)))
    

    Hm, I am not sure we should mention "Recipe" here. That is just part of the scenario -- the topic is about adding a block to a view, and it uses the Recipes view that was created in a previous step as the example to work on.

    I don't think we have mentioned recipes, farmers, vendors, etc. elsewhere.

  14. +++ b/source/en/views-concept.txt
    @@ -1,7 +1,7 @@
    -(((Views, overview)))
    +(((View,overview)))
    

    Also maybe add an entry for the Views module?

  15. +++ b/source/en/views-create.txt
    @@ -2,8 +2,8 @@
    -(((List,creating)))
    

    We lost having an entry starting with "List" here.

    Maybe something like:

    (((Listing content,using Views module)))

    or something similar would be useful?

avanraaphorst’s picture

Comments only:

Hi, Jennifer --

I believe you're back in town today. I was just reviewing what still needs to be done to finish up the index, which I hope to do between tomorrow (Thursday) afternoon and Sunday. I still think I'll need to make 2-3 more patches.

Besides addressing your comments in #9, I plan to go through the user guide output files, looking for things that haven't been indexed at all yet or need more attention. Are there any chapters or sections that you think deserve special treatment? Do you think you or other contributors will be doing a lot of work on the doc over the next 3-4 days?

Thanks, Anna

jhodgdon’s picture

I don't know of any area or topic in particular that I would send you to, to look at. We did make sure (I think/hope) that each topic has at least one index entry. Some definitely have more than others.

Regarding work over the next few days, there are a bunch of patches that I need to review/commit today hopefully (or tomorrow), which came in while I was out -- there are a few people who are working very actively on editing right now. So there should be commits happening, if that is what you are asking... I don't think they'll impact the index entries or the substance of any of the topics much (as far as what should be indexed).

Also, I don't expect any of the patches to conflict with yours, in the sense that even if they are changing some files you are also editing, they shouldn't be in the same areas of the files. So, I think you can start by doing a "git pull" to update your local copy of the repository when you are ready to start work, make your edits, and then make your patch with a "git diff"... and not worry about whether the files are changing under you in the meantime. Right?

I hope that makes sense and answers your question...

avanraaphorst’s picture

Status: Needs work » Needs review
FileSize
23.25 KB

Hi, Jennifer --

1. This will be the last patch, unless you (or I) see problems in the output. I've enjoyed doing this task and hope there will be other contributions I can make to the documentation. My husband and I are especially interested in conversion topics (Drupal 6 or 7 to 8), so if you have any unclaimed topics in that area, please let me know. We're open to others, as well -- we worked together on the DITA Open Toolkit documentation and enjoy collaborating.

2. I agree with most of your items in 2.4.4 Composing index entries. I ended up making most of the nouns singular. The only area where I left some plural forms is where the topic clearly references more than one item or object (e.g. regions). Your second bullet, not including common verbs (gerunds) I found a little hard to define ("common" or "exotic"?). I did include "configuring," although there are a fairly large number of secondary entries for that top-level entry. I do think users often look up index entries by what they are trying to do: installing, translating, uninstalling, configuring. Of course, I also indexed by the noun (usually the object of the verb). Let me know what you think.

3. One suggestion I have that might help future contributors index as they write is be to point them to the existing index, the glossary, and/or a running list of metadata terms that I presume you probably have tucked away somewhere (the names of your text files would be a good start!). Another idea is to give them some "do" and "don't" examples to follow. The last style guide I did had those, and they were very effective -- surprisingly so -- I think they worked better than descriptions or prescriptions. I created examples from the mistakes I was correcting (as an editor) and compiling an example list a few items at a time.

4. Thanks again for the opportunity, and please let me know if you think more work is required. -Anna

jhodgdon’s picture

Status: Needs review » Fixed

Great, thanks!

Regarding further work, we don't have any topics in the Guide about migrating from Drupal 6 or 7 to 8. That would be Volume 2. :) But if you want to help out with other issues, there are quite a few editing issues available at
https://www.drupal.org/project/issues/user_guide

Great suggestion regarding the guidelines. I edited the guidelines on index entries and added them with this commit.

Anyway, this patch looks great. One edit:

planning-data-types.txt -- Fields are not entity types. They are related to entity types, but themselves are not entity types. So I edited
+(((Field entity type,overview))) -> Field, overview

The rest looks wonderful. Thanks very very very much for your help in this area!!

avanraaphorst’s picture

Hi, Jennifer --

Maybe I should have seen this somewhere, but how much time is left before you plan to publish the user guide? I plan to spend some time reading through the document (!) and creating the farmers market sample site, but after that, if there is time, I'd like to help out with some of the editing. (Actually, I see that some of the tasks don't appear to require a lot of technical expertise, so maybe I'll do some of those.)

Again, thanks for the opportunity, Anna

jhodgdon’s picture

We don't really have a time frame. In a project that is being done by volunteers, it is hard to predict progress.

Definitely, most of the editing tasks that we have available at the moment require minimal expertise in Drupal. Only a few do, really. The issues that are named "Copy edit: ..." are definitely low on the expertise meter -- those are wording changes mostly. The ones named "Content edit: ..." you'd have to look at on a case-by-case basis to see what editing is needed -- those are the ones where our testing crew found problems with a topic, and some text needs to be corrected, added, removed, or clarified. Your help with any editing you'd like to do would of course be welcome, especially now that you've figured out "the system"!

Status: Fixed » Closed (fixed)

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