[#MDLSITE-495] Standardize links on plugins and Moodle forum introductions

Issue Details (XML | Word | Printable)

Key:	MDLSITE-495
Type:	Improvement
Status:	Open
Priority:	Minor
Assignee:	Chris Collman
Reporter:	Chris Collman
Votes:	1
Watchers:	1

Operations

Add/Edit UI Mockup to this issue

If you were logged in you would be able to see more operations.

Moodle.org Sites

Standardize links on plugins and Moodle forum introductions

Created: 22/Aug/08 09:00 AM Updated: 15/Sep/08 03:41 AM

Component/s:

moodle.org

File Attachments:

Format for new Plugin MoodleDoc page_v2.txt (0.5 kB)
2.

Modules_and_plugins_ChrisList_1.xls (190 kB)

Participants:	Chris Collman and Helen Foster
Security Level:	None

Description

« Hide

There should be a link to a documentation page in Using Moodle forum introductions. All the forums for core code should now have FAQ and documentation links. The documentation linked page, should have a link back to the appropriate forum.

We should bring the contributed code forums and plugins up to the same standard when possible. This might include creating a "stub" page in MoodleDocs and a link back to the Contributed Code forum if no other specific pages can be found. In the ideal world, a contributed code Plug-in page, MoodleDoc pages (General and/or FAQ) and the appropriate Forum should all be cross linked. Outside links placed by the contributor should stay.

Suggest the initial focus should be on 1.9 plugins and all contributed code forums.

Request as per Helen.

All

Comments

Change History

Sort Order:

[ Permalink | « Hide ]

Helen Foster added a comment - 25/Aug/08 05:31 PM

Hi Chris,

Thanks for your suggested improvements.

Regarding modules and plugins database entries, how about:

Documentation link - To a page in the documentation wiki containing a link to the entry in the m&p database, the stub template stub and the contributed code category [[Category:Contributed code]]
Discussion link - To discussion if one exists (search Using Moodle forums to check) otherwise to contributed modules and plugins forum http://moodle.org/mod/forum/view.php?id=44

[ Permalink | « Hide ]

Helen Foster added a comment - 25/Aug/08 07:32 PM

Sample documentation page: http://docs.moodle.org/en/Journal_module

[ Permalink | « Hide ]

Helen Foster added a comment - 25/Aug/08 11:15 PM

All contributed code forum introductions now include documentation links.

Reassigning to Chris to add documentation and discussion links to modules and plugins database entries.

[ Permalink | « Hide ]

Chris Collman added a comment - 26/Aug/08 04:26 AM

Excel list of all Modules and Plugins as of 8/25/08. Added 3 columns for date action taken (link Doc, link Discussion, notify author), will update this spreadsheet with http link to Doc and Discussion.

Started with auto filter set to 1.9 and latest, blank Doc and blank Discussion links.

[ Permalink | « Hide ]

Helen Foster added a comment - 28/Aug/08 11:40 PM

A few suggestions:

1. How about not categorizing pages as administrator, since the contributed code category is within the administrator category.
2. Change the section title "Links" to "See also" (for consistency).
3. Include the name of the module in the link to the m&p database entry e.g. http://moodle.org/mod/data/view.php?d=13&rid=1015 OU wiki module for download (or similar) (for improved accessibility).

[ Permalink | « Hide ]

Chris Collman added a comment - 29/Aug/08 12:36 AM

Thanks Helen,
ooops about the administrator category. Will change to "See also "in my sample. And I will stop being lazy and paste the Plugin datasheeet name (short name) as you suggested. I will go back and edit the pages I created to meet our new standard.

FYI and others info: I do at least 2 searches. First I do a search in MoodleDocs for the m&p database entry name or something similar. Once I am in edit mode for the "new page" (but not saved), I have another window open and use the google search field on moodle.org home's page on the database entry name. I am looking for forum references and if I missed an obvious existing page in MoodleDocs. For example in the case of OU wiki, there were some hits in the General problems forum which should not be mentioned because Contributed Code is a more appropriate forum (and our standard default). However, I saw several hits in the Wiki forum about OU wiki's functions and that is why I made an additional note on the MoodleDoc page but not on the m&p.

[ Permalink | « Hide ]

Helen Foster added a comment - 29/Aug/08 12:41 AM

Chris, you're doing a great job - many thanks

[ Permalink | « Hide ]

Helen Foster added a comment - 15/Sep/08 03:41 AM

Chris, a couple more suggestions:

4. If the maintainers field is empty, fill it in as: Wanted!
(e.g. http://moodle.org/mod/data/view.php?d=13&rid=1652 )

5. For all non-core modules and plugins, fill the status field in as: Contributed
(Sometimes people forget or don't understand the status field. Older entries have "Third-Party" status, which can be changed to "Contributed" when updating the entry to include documentation and discussion links.)

Thanks again for the great job you're doing!

All content on this web site is made available under the GNU General Public License, unless otherwise stated.