Unity Developer Documentation
Review the existing Unity developer documentation, identify areas for improvement
Blueprint information
- Status:
- Not started
- Approver:
- Jono Bacon
- Priority:
- Undefined
- Drafter:
- None
- Direction:
- Approved
- Assignee:
- Michael Hall
- Definition:
- Approved
- Series goal:
- Accepted for quantal
- Implementation:
- Unknown
- Milestone target:
- ubuntu-12.10
- Started by
- Completed by
Whiteboard
Initially there was no documentation at all on how to get involved
Now there is a new page on http://
AskUbuntu question: http://
A challenge is still to find the place on the code to do particular things
The structure of code files in Unity was updated very recently.
Feedback from a prospective Unity developer
Challenge: discoverability of documentation
SEO optimization of the online documentation
New contributors can get lost in a sea of terminology like autopilot tests, etc.
Lack of code comments is another issue.
No cross-linking between developer.u.c and unity.u.c documentation
Launchpad documentation on how to do merge proposals/code reviews: https:/
Work Items
Work items:
[mhall119] Update unity devel sourcecode layout section: DONE
[bilalakhtar] Automate build process to one script: TODO
[mhall119] Add link to file bugs against the documentation: TODO
[mhr3] Define terminology for all the UI components: TODO
[daker] Add imagemap screenshots of Unity, linking to associated source files: TODO
[mhall119] Collect Autopilot and other test writing documentation: INPROGRESS
[mhall119] Post Autopilot docs on unity.u.c: INPROGRESS
[mhall119] Gather code documentation metrics (https:/
[mhall119] Add links to documentation on submitting MPs once they are ready: DONE
[mhall119] Update API links on http://
[mhall119] Update links on http://
[mhall119] Add System Indicators link: DONE
Remove links to the wiki when similar content is on developer.u.c: TODO
Scan wiki pages and put a deprecated warning and link to developer.u.c on old pages: TODO
[mhall119] Get rid of hardware requirements wiki page (check with dbarth first): DONE
[bigwhale] Scan unity.ubuntu.com and make a list of old/outdated links (send to mhall119): TODO