Wiki source code of Onboarding

Last modified by Vincent Massol on 2024/03/25 13:54

Hide last authors
Vincent Massol 22.2 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
Vincent Massol 22.3 5 = Welcome =
Thomas Mortagne 1.1 6
Vincent Massol 22.1 7 Welcome to the XWiki community! We're very happy to see you here :)
8
Thomas Mortagne 1.1 9 This page will help you getting started as a member of the XWiki Community and start contributing to the project.
10
Vincent Massol 3.1 11 It's organized in the form of Tasks that you should perform to get familiar with the various tools and practices.
Thomas Mortagne 1.1 12
Vincent Massol 3.1 13 Since there are various domains where you could contribute, we've organized them in Tracks.
14
Vincent Massol 21.3 15 = Become part of the community =
Vincent Massol 3.1 16
Thomas Mortagne 1.1 17 First things first, let's actually join the community communication channels.
18
Ecaterina Moraru (Valica) 27.1 19 The XWiki community uses various tools to **communicate**:
Thomas Mortagne 1.1 20
Ecaterina Moraru (Valica) 25.1 21 1. Register on https://www.xwiki.org (//Hint: click the Drawer icon in the top right corner of the screen//)
Vincent Massol 3.1 22 1. Register on https://forum.xwiki.org using your XWiki.org account (//see [[Community.Discuss]] for more details//) and introduce yourself by creating a post in https://forum.xwiki.org/c/Other
23 1. Register on https://riot.im/app/, access the ###xwiki## chat room and say hello (//see [[Community.Chat]] for more details//)
Thomas Mortagne 1.1 24
Vincent Massol 33.3 25 If you are interested in the **development** part of our community, you should also:
Ecaterina Moraru (Valica) 25.1 26
27 1. Create an account on our [[issue tracker>>https://jira.xwiki.org]], in order to report and fix issues.
28 1. Have a [[GitHub>>https://github.com]] account, if you want to make a [[pull request>>https://help.github.com/articles/creating-a-pull-request]] to our [[source repositories>>dev:Community.SourceRepository]].
Vincent Massol 34.1 29 1. Make sure you read and follow our [[guidelines for contributing code>>dev:Community.Contributing||anchor="HContributeCode"]].
Ecaterina Moraru (Valica) 25.1 30
Vincent Massol 34.2 31 If you are interested in developing on top of the XWiki platform (e.g. scripting in wiki pages or even writing your own extension), then it's recommended to read the [[Dev Guide>>xwiki:Documentation.DevGuide.WebHome]] (which is different from [[dev.xwiki.org>>dev:Main.WebHome]] which is for developers of XWiki and its contrib extensions).
Vincent Massol 34.1 32
Simon Urli 29.1 33 = Getting to know XWiki =
Vincent Massol 3.1 34
Simon Urli 32.1 35 * Track 1: [[Understand XWiki concepts of XClass & XObjects>>TrackXObjects]]
36 * Track 2: [[Extend your application>>TrackMacro]]
37 * Track 3: [[Styling XWiki>>TrackStyling]]
Vincent Massol 4.1 38
Simon Urli 30.1 39 = Start contributing =
Vincent Massol 21.2 40
Simon Urli 32.1 41 * Track 4: [[Report or find an issue>>TrackIssues]]
42 * Track 5: [[Contribute to the core>>TrackCore]]
Simon Urli 29.1 43
Ecaterina Moraru (Valica) 23.3 44 Future tracks to document:
45
Simon Urli 31.1 46 * Track: Interactivity in XWiki (JSX, WebJars, Special CSS classes, Front-end Resources)
47 * Track: Contribute to an existing extension
48 * Track: Contribute a new extension
49 * Track: Add translations
Ecaterina Moraru (Valica) 23.3 50
Vincent Massol 23.2 51 Other resources:
52
53 * [[Getting started with XWiki for extension developers>>doc:Drafts.GettingStartedWithXWiki]]. Note: We need to merge this document into those onboarding pages.
54
Vincent Massol 21.1 55 {{comment}}
Ecaterina Moraru (Valica) 24.2 56 [[Translations Tutorial>>doc:Drafts.TranslationsTutorial]]
57
Vincent Massol 21.1 58 IDEA: reuse info from [[http:~~/~~/dev.xwiki.org/xwiki/bin/view/Drafts/GettingStartedWithXWiki>>doc:Drafts.GettingStartedWithXWiki]] or do something with it
Vincent Massol 4.2 59
Thomas Mortagne 1.1 60 = Report issues =
61
Thomas Mortagne 2.1 62 Register in https://jira.xwiki.org (//see [[Community.Contributing||anchor="HReportanissue"]] for more details//).
Thomas Mortagne 1.1 63
64 = Contribute translations =
65
66 Register on http://l10n.xwiki.org.
67
68 = Contribute code =
69
70 == Contribute an extension ==
71
72 Writing or contributing to an extension is generally the best way to to get used to XWiki APIs and architecture.
73
74 === Fix bugs ===
75
76 === Introduce new features ===
77
Vincent Massol 21.1 78 When thinking about introducing a new feature or a big changes it's important to explain what you plan to do (even if your are not 100% sure yet) in an entry of http://design.xwiki.org and to talk about it on the devs mailing list. That way you will get advices on how to improve your proposal or warning if you are not going in the right direction.
79 {{/comment}}

Get Connected