Difference between revisions of "Docs Wiki Roadmap"
From Joomla! Documentation
m (→Short Term: crossing one off list as done) |
m (→Nice to have eventually: updates) |
||
| (12 intermediate revisions by the same user not shown) | |||
| Line 10: | Line 10: | ||
::*Beginners need targeted core ideas and methods (Too much information puts off) | ::*Beginners need targeted core ideas and methods (Too much information puts off) | ||
::*Easy to navigate and follow | ::*Easy to navigate and follow | ||
| − | ::*Use of [[mw:Extension:Header_Tabs|Header Tabs extension]] | + | ::*<strike>Use of [[mw:Extension:Header_Tabs|Header Tabs extension]]</strike> |
| + | :::'''Installed!''' see example of use [[User:Hutchy68/Getting Started test page|Hutchy68/Getting Started test page]] or [[Installing Joomla!]] | ||
:*Developers - more involvement, better method of involvement | :*Developers - more involvement, better method of involvement | ||
| + | ::*Projects - [[JDOC:Developer Tutorials Project]], | ||
| + | ::*Better Event integration such as Pizza, Bugs and Fun. Doc's home page integration, upcoming events template. | ||
:*Web designers - target ease of design, better articles targeted towards CSS, Bootstrap | :*Web designers - target ease of design, better articles targeted towards CSS, Bootstrap | ||
| + | ::*Projects - need ideas | ||
:*Administrators - target common tasks with more detail | :*Administrators - target common tasks with more detail | ||
:*Evaluators - ideas needed? | :*Evaluators - ideas needed? | ||
| Line 18: | Line 22: | ||
*Home page - start of redesign is [[User:Hutchy68/New main page|here]] | *Home page - start of redesign is [[User:Hutchy68/New main page|here]] | ||
*Navigation | *Navigation | ||
| − | + | :*Portal pages | |
| − | * | + | :*<strike>Better documentation search - Google integration? Lucerne?</strike> |
| − | + | ::'''Installed!''' Google CSE, [[Special:GoogleCustomWikiSearch|GoogleCustomWikiSearch]] - implemented and being used. | |
| − | + | :*Improve structure ('''underway!''') | |
| − | **Disambiguation pages | + | ::*Namespace aliases for easier link building |
| − | *Spam control - multipage sign up. AntiSpoof, AbuseFilter together. AbuseFilter will automatically block and remove users based on rules, can be new user time sensitive running against only new users. | + | :::'''Help screen aliasing''' - All Joomla! 3.x series Help screens will alias to one set of Help screens |
| − | *Clean up redundant and incomplete pages (what was started and never finished, or redundant) | + | ::*<strike>Custom extension to tag Namespaces</strike> |
| − | :*Investigate 'Archive' namespace, would want an alias of 'A' to simplify link creation when needed | + | :*Disambiguation pages |
| + | *<strike>'''Spam control''' - multipage sign up. AntiSpoof, AbuseFilter together.</strike> | ||
| + | :*<strike>AbuseFilter (Tested! - see [[JDOC_talk:Docs Wiki Roadmap|Talk page]]) - will automatically block and remove users based on rules, can be new user time sensitive running against only new users.</strike> | ||
| + | ::'''Installed!''' and working now, see [[Special:AbuseLog|AbuseLog]] and [[Special:AbuseFilter|AbuseFilter]] | ||
| + | *Clean up redundant and incomplete pages (what was started and never finished, or redundant) ('''Underway!''') | ||
| + | :*</strike>Investigate 'Archive' namespace, would want an alias of 'A' to simplify link creation when needed</strike> | ||
| + | ::'''Installed!''' Archive namespace and J1.5 for Joomla! 1.5 articles now being tagged ''Archived'' ('''Underway!''') | ||
===Long Term=== | ===Long Term=== | ||
| Line 45: | Line 55: | ||
===Nice to have eventually=== | ===Nice to have eventually=== | ||
| − | *VEL page | + | *<strike>VEL page</strike> '''VEL now has its own subdomain, see http://vel.joomla.org. |
| − | **Improvement for editing by approved VEL members | + | **<strike> Improvement for editing by approved VEL members</strike> |
| − | **Searching | + | **<strike> Searching</strike> |
| − | **Improved look | + | **<strike> Improved look</strike> |
| − | **Integration with administration for VEL notifications of installed Extensions. | + | **<strike> Integration with administration for VEL notifications of installed Extensions.</strike> |
| − | * Multilingual support | + | * Multilingual support '''(Investigation underway)''' Translate Extension. |
| + | |||
==Investigation== | ==Investigation== | ||
*Semantic Mediawiki | *Semantic Mediawiki | ||
| − | + | :*Use of property values within articles/API (testing underway!) | |
| − | **External data capture in XML or JSON (other formats also available) | + | ::*Testing on a local MW install, use of Doxygen xml files to create API pages for documentation. |
| + | :*External data capture in XML or JSON (other formats also available) | ||
<noinclude>[[Category:Documentation Wiki Information|{{PAGENAME}}]] | <noinclude>[[Category:Documentation Wiki Information|{{PAGENAME}}]] | ||
Revision as of 15:06, 12 June 2013
General Information
Please add appropriate items to the Roadmap and post all comments to the Docs Wiki Roadmap talk page.
Docs Wiki Roadmap[edit]
Short Term[edit]
- Identify documentation needs by user type better
- Beginners - need to be more targeted
- Easy Tutuorials - short and concise (using as a model - Wikipedia's Wikipedia:Tutorial)
- Beginners need targeted core ideas and methods (Too much information puts off)
- Easy to navigate and follow
Use of Header Tabs extension
- Installed! see example of use Hutchy68/Getting Started test page or Installing Joomla!
- Developers - more involvement, better method of involvement
- Projects - JDOC:Developer Tutorials Project,
- Better Event integration such as Pizza, Bugs and Fun. Doc's home page integration, upcoming events template.
- Web designers - target ease of design, better articles targeted towards CSS, Bootstrap
- Projects - need ideas
- Administrators - target common tasks with more detail
- Evaluators - ideas needed?
Recognition of contributions, work on wikicomplete, see Barnstar awards- Home page - start of redesign is here
- Navigation
- Portal pages
Better documentation search - Google integration? Lucerne?
- Installed! Google CSE, GoogleCustomWikiSearch - implemented and being used.
- Improve structure (underway!)
- Namespace aliases for easier link building
- Help screen aliasing - All Joomla! 3.x series Help screens will alias to one set of Help screens
Custom extension to tag Namespaces
- Disambiguation pages
Spam control - multipage sign up. AntiSpoof, AbuseFilter together.
AbuseFilter (Tested! - see Talk page) - will automatically block and remove users based on rules, can be new user time sensitive running against only new users.
- Installed! and working now, see AbuseLog and AbuseFilter
- Clean up redundant and incomplete pages (what was started and never finished, or redundant) (Underway!)
- Investigate 'Archive' namespace, would want an alias of 'A' to simplify link creation when needed
- Installed! Archive namespace and J1.5 for Joomla! 1.5 articles now being tagged Archived (Underway!)
Long Term[edit]
- Increase developer contributions!
- Welcome new users on user talk pages! Give them some additional information, style guide, templates available, etc.
- Editor assistance
- Adopt an editor? Help new wiki users
- Wiki Doc Projects - "JDOC Projects" - Portal page:JDOC Projects
- Developers
- Designers
- Better tutorials, multipage, PDF's created for download
- Developer feedback
- Enhance styleguide
- API integration with Platform and CMS
- Help Screen development simplify
- Focus on first STS, transcluded to subsequent STS versions, with a 'Final' for LTS
- Notices on support ended versions
- Better understanding for contributors, Help screens: how they work, why style guides are important
Nice to have eventually[edit]
VEL pageVEL now has its own subdomain, see http://vel.joomla.org.Improvement for editing by approved VEL membersSearchingImproved lookIntegration with administration for VEL notifications of installed Extensions.
- Multilingual support (Investigation underway) Translate Extension.
Investigation[edit]
- Semantic Mediawiki
- Use of property values within articles/API (testing underway!)
- Testing on a local MW install, use of Doxygen xml files to create API pages for documentation.
- External data capture in XML or JSON (other formats also available)