Show last authors
1 This is supposed to be a Getting Started guide for **developers** that want to work on the XWiki.org project or that just want to build a project on top of XWiki.
2
3 It is just a collection of already existing documentation resources, but gathered in one reference place and structured in an order that should reflect a good flow for the learning process.
4
5 For the record, there also already exist a [[Getting Started guide for users>>http://enterprise.xwiki.org/xwiki/bin/view/GettingStarted/WebHome]].
6
7 A. **XWiki Product presentation**
8 * wiki model (page, space, wiki) (objects, classes)
9 ** http://enterprise.xwiki.org/xwiki/bin/view/GettingStarted/WhatIsAWiki
10 ** http://platform.xwiki.org/xwiki/bin/view/DevGuide/Architecture
11 ** http://platform.xwiki.org/xwiki/bin/view/DevGuide/DataModel
12 * major features we have (document lifecycle [CRUD, versioning], comments, attachments, EM, AWM, livetable, Administration, Rights, Import/Export, Users/Profile, Dashboard, Annotations, REST, Panels, AS, SOLR, WYSIWYG, Syntax, Macros [Content/Code], Skins/Themes, Internationalisation, Extensions)
13 ** http://enterprise.xwiki.org/xwiki/bin/view/UserGuide/WebHome
14 ** http://enterprise.xwiki.org/xwiki/bin/view/Main/Features
15 *** can be compared with http://platform.xwiki.org/xwiki/bin/view/Main/WebHome to understand how the XWiki Enterprise ##product## is built on top of the platform and adds default applications
16 * what is the future vision (flavours, design.xwiki.org, cycle theme)
17 ** http://design.xwiki.org/xwiki/bin/view/Main/WebHome
18
19 B. **XWiki Product Development Process**
20 * http://www.slideshare.net/Enygma2002/development-process-the-xwiki-way
21 * http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices#HGeneralDevelopmentFlow
22 * http://dev.xwiki.org/xwiki/bin/view/Main/WebHome
23 * what happens in the community development area
24 * development cycle: release, roadmap, tools we use: mailinglists, irc, issue tracker, ci, l10n, etc.
25
26 C. **Finding documentation and reporting issues**
27 * how to find documentation (about the features, about the development platform) (user, developer, admin guides)
28 ** http://www.xwiki.org/xwiki/bin/view/Main/Documentation
29 ** http://enterprise.xwiki.org/xwiki/bin/view/Main/Features and http://extensions.xwiki.org/xwiki/bin/view/Main/WebHome
30 ** http://enterprise.xwiki.org/xwiki/bin/view/UserGuide/WebHome
31 ** http://platform.xwiki.org/xwiki/bin/view/AdminGuide/WebHome
32 ** http://platform.xwiki.org/xwiki/bin/view/DevGuide/WebHome
33 * how to know if something is broken (across skins, release notes, blaming)
34 ** http://www.xwiki.org/xwiki/bin/view/ReleaseNotes/
35 ** http://dev.xwiki.org/xwiki/bin/view/Community/SourceRepository
36 ** Jira's "Commits" tab for each issue. Example: https://jira.xwiki.org/browse/XWIKI-10568?page=com.atlassian.jira.plugins.jira-bitbucket-connector-plugin:dvcs-commits-tabpanel
37 * how to report an issue on these features or knowing that your problem is already fixed
38 ** https://jira.xwiki.org/secure/BrowseProjects.jspa#all
39 ** https://jira.xwiki.org/issues/?jql=
40
41 D. **Contributing an extension**
42 * Finding extensions on e.x.o
43 ** http://extensions.xwiki.org/xwiki/bin/view/Main/WebHome
44 * Installing extensions with/without EM
45 ** http://platform.xwiki.org/xwiki/bin/view/AdminGuide/ImportExport
46 ** http://extensions.xwiki.org/xwiki/bin/view/Extension/Extension+Module+Architecture
47 ** http://extensions.xwiki.org/xwiki/bin/view/Extension/Extension+Manager+Application
48 * Creating new extensions with/without AWM
49 ** http://platform.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorial
50 ** http://platform.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorialAWM
51 ** http://platform.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorialManual
52 * Publishing an extension on e.x.o:
53 ** publish a XAR
54 ** contrib.xwiki.org
55 *** creating a repo, a jira project, e.x.o page for your extension
56 *** releasing the extension
57 *** http://contrib.xwiki.org/xwiki/bin/view/Main/WebHome
58 * Contributing to an existing extension
59 ** creating a pull request
60 *** https://help.github.com/articles/using-pull-requests
61
62 E. **Contributing back to the product**
63 * Comparison with contrib (repos layout, pull requests, reviewing process, discussions, etc.)
64 * Ways you can help
65 ** http://dev.xwiki.org/xwiki/bin/view/Community/Contributing
66 * Guidelines and Best Practices
67 ** http://dev.xwiki.org/xwiki/bin/view/Community/DevelopmentPractices
68 ** http://dev.xwiki.org/xwiki/bin/view/Community/CodeStyle
69 ** http://dev.xwiki.org/xwiki/bin/view/Community/ApplicationDevelopmentBestPractices
70 *** alternative draft (not official for the product): http://dev.xwiki.org/xwiki/bin/view/Drafts/Best+Practices+XWiki+Application+Organization

Get Connected