Closed (fixed)
Project:
Pathauto
Version:
8.x-1.x-dev
Component:
Documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
27 Jan 2016 at 09:44 UTC
Updated:
5 Apr 2016 at 00:34 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
berdirI personally find it to be rather useless documentation to say which dependencies you need. Drupal tells you that if you're missing them.
And the instructions on how to create patterns should IMHO at least also be added as a pathauto_help(), then we can make it context sensitive for the list and add pages.
Comment #3
raj45 commentedI think it's valuable information, though. Perhaps it could be added to Pathauto main page?
Comment #4
pguillard commentedI added this documentation to README.md and the hook_help, and removed a typo in the text and issue summary.
Comment #5
pguillard commentedComment #6
berdirThanks or working on this. If you mention dependencies, I'd actually mention them, ctools and token.
Also, we don't need that part inside hook_help(), a user has already installed it.
Instead of describing where to go and what to do there, we should try to add some context specific help for the pattern overview and add form. Then it will be displayed on those pages, see how other help hooks do it.
Comment #7
pguillard commentedYou are right.
I applied your suggestions except I didn't provide help for the pattern overview.
Comment #8
berdirthis is not about content types, it's about entity types. And theoretically, could also be about something different. I also think we don't need a description here, I think the values in the select explain themself. Having an example in the pattern definitely helps, though.
Note that that's not what I meant, what I meant is to have a help text for the overview and add page, not descriptions of the fields. I think the help text for the add page should explain that you have to select a pattern type, pattern and filter to what exactly it should apply (I'd try to avoid being too specific about languages/content types.. single-language sites won't see a language filter and some pattern types don't have bundles. And we might make this more flexible in the future.
Comment #9
berdirTo be clear, I'm thankful for anyone working on this. While issues like this seem easy at first, they're actually quite hard on a non-technical level. Writing good and useful documentation is *very* hard.
I'd also love to get feedback from new users and others. I'm definitely not the best person to judge about the help text I can only comment on the technical correctness. I'm working on an update in the contrib_tracker issue and I will point people to this issue and ask them to help out here.
Comment #10
pguillard commentedI know it is hard, especially as a non English native, so yes, feedback from others users is welcomed.
I suggest this patch, at least to get back to the right direction.
My suggestions here are :
Overview page (inspired from what I found on similar situations on core) :
Add page (from #8):
Comment #11
raj45 commentedComment #12
dermarioI just stumbled over that issue and had a look on the latest patch.
This should be "Configuration".
Comment #13
peschmae commentedComment #14
peschmae commentedI've fixed the typo mentioned in #12
Comment #16
berdirNo feedback on the content, despite my call for help in the contrib_tracker issue. I guess that means this is fine and most users are able to figure out the UI themself.
Works for me, committed.