Actions

Difference between revisions of "Developer Area"

From Mahara Wiki

(Developer Documentation: dev ideas moved to the current tasks page)
 
(50 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 +
{{:Developer_Area/tabs}} <!-- to add further tabs, update the following page https://wiki.mahara.org/wiki/Developer_Area/tabs ... this will automatically cascade the changes to all relevant pages -->
 +
 
Here is a bunch of developer documentation for Mahara, including design, policy and specific feature documents.
 
Here is a bunch of developer documentation for Mahara, including design, policy and specific feature documents.
  
 
This is for people who want to understand how Mahara works, or want to develop new code or plugins for Mahara. If you want to customise your Mahara - e.g. change the language/theme, or simply install plugins, check out the [[Customising]] section.
 
This is for people who want to understand how Mahara works, or want to develop new code or plugins for Mahara. If you want to customise your Mahara - e.g. change the language/theme, or simply install plugins, check out the [[Customising]] section.
  
==Developer Documentation==
+
<div style="float:right">__TOC__</div>
 +
 
 +
== Overview ==
  
 +
* [[Developer Area/Mahara project overview|Mahara development overview]] - explains how Mahara gets developed, who does it, and how people become Mahara developers
 
* [[Developer Area/Mahara Architecture Introduction|Mahara Architecture Introduction]] - this series of articles explains how Mahara fits together, where it's pluggable and why it's written the way it is.
 
* [[Developer Area/Mahara Architecture Introduction|Mahara Architecture Introduction]] - this series of articles explains how Mahara fits together, where it's pluggable and why it's written the way it is.
 
* [[Developer Area/Plugins|Plugins]] - (soon to be) your one-stop-shop for information about developing plugins for Mahara
 
* [[Developer Area/Plugins|Plugins]] - (soon to be) your one-stop-shop for information about developing plugins for Mahara
 
* [[Developer Area/Language Packs|Language Packs]] - how to write a language pack for Mahara, and how to contribute it back
 
* [[Developer Area/Language Packs|Language Packs]] - how to write a language pack for Mahara, and how to contribute it back
 
+
* [[Developer Area/Documentation Wishlist|Wishlist]] - what documentation did you find missing and would like people to contribute?
<div style="clear:both; width:96%; background-color:#eee; float:left;padding:1% 2% 2% 2%;margin-top:30px;margin-bottom:30px;">
+
* And if you just want the [[Developer Area/Source code|source code]], it's available via [http://en.wikipedia.org/wiki/git git] at
    <div style="float:left; width:25%; margin-right:5%;">
+
** Our gerrit code review system: <tt>git clone https://reviews.mahara.org/mahara</tt>
        <div style="text-align:center;">
+
** git.mahara.org: https://git.mahara.org/mahara/mahara
<!--
+
** Github: https://github.com/MaharaProject/mahara
 
+
* [[Developer Area/Common issues|Common issues]]
# This section is for architecture information that developers need to know.
 
 
 
-->
 
        <h3>Finding your way around</h3>
 
        </div>
 
        <div style="background-color:white;border-top:3px solid #666;border-bottom:1px solid #999;padding:20px;">
 
* [[Developer_Area/Mahara_Architecture_Introduction|Mahara Architecture Introduction]]
 
* [[Developer_Area/Core_Subsystems|Core Subsystems]]
 
* [[Developer_Area/Database_conventions|Database conventions]]
 
* [[Developer_Area/Development_Tutorials|Development Tutorials]]
 
* [[Developer_Area/HowToWriteAViewTemplate|How to write a view template]]
 
* [[Developer_Area/Import//Export|Import/Export]]
 
* [[Developer_Area/Language_Packs|Language Packs]]
 
* [[Developer_Area/Plugins|Plugins]]
 
* [[Developer_Area/Release_Policy|Release Policy]]
 
 
 
        </div>
 
    </div>
 
    <div style="float:left; width:25%; margin-left:7.5%;">
 
        <div style="text-align:center;">
 
<!--
 
 
 
# This section is for guides for getting development environments set up
 
 
 
-->
 
        <h3>Getting set up</h3>
 
        </div>
 
        <div style="background-color:white;border-top:3px solid #666;border-bottom:1px solid #999;padding:20px;">
 
* [[Developer_Area/Developer_Tools|Setting up your development tools]]
 
* [[Developer_Area/Getting_Code_from_Git|Getting Code from Git]]
 
* [[Developer_Area/Changing_Hostnames|Changing Hostnames]]
 
 
 
        </div>
 
        <div style="height:20px;"></div>
 
        <div style="text-align:center;">
 
<!--
 
 
 
# This section is for guides for submitting improvements (bug reports, patches, etc)
 
 
 
-->
 
        <h3>Contributing improvements</h3>
 
        </div>
 
        <div style="background-color:white;border-top:3px solid #666;border-bottom:1px solid #999;padding:20px;">
 
* [http://mahara.org/tracker/ How to submit good bug reports]
 
* [[Developer_Area/Bug_Status|Bug Status Policy]]
 
* [[Developer_Area/Bite_Sized|Bite sized code tasks]]
 
* [[Developer_Area/Coding_guidelines|Coding guidelines]]
 
* [[Developer_Area/Contributing_Code|Contributing Code]]
 
* [[Developer_Area/Code_Review|Commit Policy]]
 
 
 
        </div>
 
    </div>
 
    <div style="float:right; width:25%; margin-left:4%;">
 
        <div style="text-align:center;">
 
<!--
 
 
 
# This section is for contact info
 
 
 
-->
 
        <h3>Join in the discussion</h3>
 
        </div>
 
        <div style="background-color:white;border-top:3px solid #666;border-bottom:1px solid #999;padding:20px;">
 
We have [http://mahara.org/group/view.php?id=1 a discussion forum] on mahara.org.
 
 
 
You can also find us in #mahara-dev on irc.freenode.net
 
 
 
If you have not got an IRC client or cannot connect with one, you can use the [http://webchat.freenode.net/?channels=mahara-dev&uio=MTE9MTAz8d freenode web client].
 
        </div>
 
        <div style="height:20px;"></div>
 
        <div style="text-align:center;">
 
<!--
 
 
 
# This section is for guides for the dev team
 
 
 
-->
 
        <h3>Meeting minutes & dev team notes</h3>
 
        </div>
 
        <div style="background-color:white;border-top:3px solid #666;border-bottom:1px solid #999;padding:20px;">
 
* [[Developer_Area/Current_Tasks|Current Tasks]]
 
* [[Developer_Area/Developer_Meetings|Developer Meetings]]
 
* [[Developer_Area/Release_Instructions|Release Instructions]]
 
* [[Developer_Area/Security_Team|Security Team]]
 
* [[Developer_Area/Specifications_in_Development|Specifications in Development]]
 
 
 
        </div>
 
    </div>
 
 
 
</div>
 
 
 
==Useful Resources==
 
 
 
* You can [https://code.launchpad.net/~vcs-imports/mahara/master/+subscribe subscribe to the master branch] on Launchpad to receive an email everytime a commit is made. There is also an  [http://gitorious.org/mahara/mahara.atom RSS feed of commits] if you prefer to receive information that way.
 
* #mahara-dev on freenode (irc.freenode.org) is an IRC channel where the core developers discuss the development of Mahara. This channel is not for support of Mahara (use #mahara instead), but you can lurk and listen in on developer conversations - and even hear about the latest new features as they're added ;)
 
 
 
== Archived pages ==
 
 
 
This is a collection of pages which contain information that is old or included elsewhere now.
 
 
 
* [[Developer_Area/Git_Repository_Policy|Git Repository Policy]]
 
  
 
[[Category:Developer Area]]
 
[[Category:Developer Area]]

Latest revision as of 15:27, 15 May 2020

 
Overview Finding your way around Dev setup Dev tools Contributing
Join discussion API Docs Architecture Useful Resources

Here is a bunch of developer documentation for Mahara, including design, policy and specific feature documents.

This is for people who want to understand how Mahara works, or want to develop new code or plugins for Mahara. If you want to customise your Mahara - e.g. change the language/theme, or simply install plugins, check out the Customising section.

Contents

Overview