Moodle

create good (user) docs per plugin

Details

  • Type: Sub-task Sub-task
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 2.0
  • Fix Version/s: 2.0.1
  • Component/s: Portfolio API
  • Labels:
    None
  • Affected Branches:
    MOODLE_20_STABLE
  • Fixed Branches:
    MOODLE_20_STABLE

Description

09:30 < moodler> We need some good docs, easily accessible from the setup screen, with info on how to set
up boxnet to get the API key
09:31 < moodler> and likewise for all other plugins
09:33 < moodler> On the admin settings pages, you should set $CFG->pagepath too ... it affects the docs
link later on. You an see similar examples on the other module plugin settings pages.

Activity

Hide
Penny Leach added a comment -

set pagepath, now for the simple task of creating the docs

Show
Penny Leach added a comment - set pagepath, now for the simple task of creating the docs
Hide
Penny Leach added a comment -

started box.net docs page with very basic docs on how to get the api key.

http://docs.moodle.org/en/admin/manageportfolio/boxnet

maybe someone can help with documentation

Show
Penny Leach added a comment - started box.net docs page with very basic docs on how to get the api key. http://docs.moodle.org/en/admin/manageportfolio/boxnet maybe someone can help with documentation
Hide
Helen Foster added a comment -

Penny, thanks for ensuring each portfolio settings page has an appropriate Moodle Docs for this page link. Most links currently redirect to http://docs.moodle.org/en/Portfolios as there doesn't seem to be any need for specific documentation.

I notice both Box.net and Flickr have setup instructions on the page in Moodle, which I think is better than in Moodle Docs as the language strings are more likely to be translated into other languages.

Show
Helen Foster added a comment - Penny, thanks for ensuring each portfolio settings page has an appropriate Moodle Docs for this page link. Most links currently redirect to http://docs.moodle.org/en/Portfolios as there doesn't seem to be any need for specific documentation. I notice both Box.net and Flickr have setup instructions on the page in Moodle, which I think is better than in Moodle Docs as the language strings are more likely to be translated into other languages.

People

Vote (1)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: