Wiki Topics

[Daniel Zwolenski]

Obvious ones:

- Source Control/Forest hierarchy explanation (what forest is what, how
does it all link up, where should we be working)
- Step-by-step how to check-out, setup a dev/build environment for each OS
(IDE agnostic, or one per IDE)
- Testing requirements, code styles, best practices, patterns and
architecture guidelines to follow, etc (one big one would be guidelines on
backwards compatibility stuff).
- How to communicate intent to do work, where to post proposals and how to
frame them or who to contact for each area of the code, etc (how long
should you expect before a response, what to do if you don't get a response
in that time, etc)
- How to check-in, contribute a patch, get it reviewed, etc (again
expectations on turn around and inclusion time - avoid "I posted this
yesterday and it's not been handled yet", etc).
- Any legal stuff - OCA, your rights, my rights, etc. Relationship between
Oracle JFX and OSS JFX.
- General life-cycle of a release (I assume there's planning, doing,
testing, feature freeze, code freeze, release, or something like that) and
what happens in each phase, etc

I think the packaging/deployment stuff is needed too (and currently fairly
overlooked), but perhaps should be a separate wiki section as I think it
has some different requirements. It is basically a stand-alone project (and
possibly could be made more so).

Some others (some may be better done in JIRA):

- building JFX vs the JDK/JRE and how that all links in
- details on the native side of things (i.e. what sections are native and
what does it do, how does it get built on each platform, etc).
- a list of the actual platforms that the build delivers on (i.e. is there
one linux version or six)?

- a page listing each of the components used in JIRA and what they
specifically relate to (and if there's a key person responsible for that,
who that is).
- something somewhere that decodes the versions
- a roadmap (or "wish list" if road map feels like too much commitment),
i.e. we would like to be working on these major features for version 8, etc
and version 8 is probably going to be in Q3 2013 or whatever - also general
info about when feature/code freezes happen, etc


Slightly off-topic, I'd like Ensemble to be a non-Netbeans project as much
as possible. I haven't looked in a while but last time I did, the ANT
scripts seemed to be some weird NetBeans scripts with all sorts
of unintelligible (to me) muck in them.





On Wed, Jan 23, 2013 at 6:56 AM, Richard Bair <richard.bair at oracle.com>wrote:

> Hi,
>
> I want to write a bunch of documentation on our wiki around working with
> and contributing to openjfx. Some of this will be on-boarding documentation
> (including building, testing, etc). Some of it will be architecture. Some
> of it will be features.
>
> What are the things you'd like documented on there? What would have been
> (or would still be) most useful in understanding the platform when
> approaching it from the perspective of a contributor (whether contributing
> patches or bug reports etc)?
>
> Thanks!
> Richard