In the readme.txt
Please add actual installation instructions (and move to top of document):
- that include what the dependencies are
- what order dependencies should be installed in
- what dependencies, and sub-modules thereof, need to be enabled
- what minimum configuration the dependencies need

Please add above instructions from both a web interface viewpoint and a Drush viewpoint.

If the standard methods for using Drush to install are either broken or don't work, please indicate so, along with any special Drush instructions / workarounds.

Please define either the menu or file path for:
- "Configure the administration options (see "Administrator Role" above)"

Please identify what "the administration options" are, and what values for them; should be / mean / how to reset to default / etc.

Please update the rest of the document for completeness for 7.x.

On page http://drupal.org/project/answers:
- please add a "Read documentation" link under "Resources"
- - linking to the existing readme.txt is fine

Best,
Sam

Comments

hefox’s picture

hefox commented
Title: Update documentation so 7.x will install » Update documentation for 7.x
Category: support » feature

> If the standard methods for using Drush to install are either broken or don't work, please indicate so, along with any special Drush instructions / workarounds.
....
>Please add actual installation instructions (and move to top of document):
Personally I'm objectionably to this. A module should not need complex instructions for installation unless it has complex instructions for installation -- answers doesn't, as far as I can tell (I've installed it myself fine recently). If it doesn't install cleanly against 7.x, that's a bug and should be addressed in the other issue queue post you created on this.

I'm putting my vote in to clarify and slim down on the Documentation; too much documentation is hard to maintain. Ie instead of list the dependencies, "Download the dependencies" (see .info file for list) -- however, dependencies is something anyone downloading modules should know to download the dependencies of it also, and don't see why a specific module would need to have instructions on it (I could be being arrogant about this though).

Michael-IDA’s picture

Michael-IDA commented

Hi Fox,

Mostly I just want to get this installed, so I can have a client eval this over a build-your-own KnowledgeBase / User QA system. But here's the reason behind why I added this request:

A) You currently can't install from a standard drush command, because some dependencies are missing "recommended release" tags. (eva and nodereference_count. For the Supporting Modules vud_node, userpoints_rules, entity_token, {and I give up listing them, Vote Up/Down doesn't even have a dev D7})

B) On the Answers project page, it shows List (http://drupal.org/project/list) as a D7 dependency, but drush bitches there is "No release history available for list 7.x." (and per List's project page, it doesn't even look like a module anymore).

and,
C) Personally I'm against any forcing of a user to untar something just to see its install instructions or its dependencies. If you want to link to the git copy of the readme and .info on the project page, okay, but, please don't make it any harder to install a module than it has to be.

# # #
>>"dependencies is something anyone downloading modules should know to download the dependencies of it also, and don't see why a specific module would need to have instructions on it (I could be being arrogant about this though)."

I agree with you, and I don't think that's arrogant... But, Answers is not really installable as is, so it needs something to get the average user able to install it.

# # #
And since the module doesn't seem to actually create Roles on it's own, you might re-write the section:

There are 5 relevant roles (these are not drupal system roles but rather types of users for the module):
1	Viewers: Those who view questions and answers
2	Question Authors: Those who ask a question.
3	Answer Authors: Those who answer a question
4	Site Administrator: Those who have the "administer settings" privilege and who can set up the module
5	Site Developer: Those who code sites using modules

So that it doesn't imply there should be several new Roles after the module is installed.

Personally I think the module should create the relevant Roles (1, 2, and 3), as everyone who installs the module is going to have to create these roles anyway (or worse add permission to other existing roles).

# # #

Adding this documentation request here, as we're going to have to abandon trying Answers until Answers Userpoints has at least some sort of D7 version:

- Please add a note on the project page that "Answers Userpoints" has no working D7 version.

That would have saved me several hours and yourself a few issue tickets...

Best,
Sam

hefox’s picture

hefox commented

I really don't recall any problems with installing via drush than the average drupal 7 module (where I sorta expected that not everything is quite stable). I think I just did drush dl answers, drush en, resolved missing dependency (vud?), and enabled away.

I personally can't edit the project page, but it does look like list isn't needed so can be removed.

edit: I just installed via drush a second time on a new install. Totally easy; only one unmet dependency and drush asked me what version to download. Perhaps needs a newer version of drush?

pixelsweatshop’s picture

pixelsweatshop commented

On the Answers project page, it shows List (http://drupal.org/project/list) as a D7 dependency, but drush bitches there is "No release history available for list 7.x." (and per List's project page, it doesn't even look like a module anymore).

The project page references the List module at http://drupal.org/project/list

But the dependency is the list module in core. The project page needs to be updated.

chipcleary’s picture

chipcleary commented
Status: Active » Needs review

Hi, thanks for the input.

Project page now updated to eliminate "list" dependency for D7.

I've also removed it as a dependency from answers.info.

I've updated the readme to give the admin path correctly (it was a D6 path before) as well as note that the "roles" I describe are not system roles.

Further feedback welcome.

chipcleary’s picture

chipcleary commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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