In https://issues.apache.org/jira/browse/ATLAS-2049 I am aiming to document 
some thoughts around standards for our new proposed OMAS interfaces. Since this 
is really internal documentation and tightly related to the code I think (and 
this was suggested by others too) that this should be added into the twiki 
structure in the source tree. That's fine and I'll do exactly that with 
discussion in ATLAS-2049

HOWEVER editing support for twiki is a little limited (for example there's no 
easy to use plugin for IntelliJ that I found), and though the format is a 
relatively simple markup, I wondered if better options might be to either go 
with:
* HTML - plenty of editor choice, some pages & api ref already are in this form
* markdown - this is increasingly becoming standard ie our README.md files

We don't have that much content in the twiki, and moving forward I do think it 
would be useful to extend/update with "reference" material, so it could be an 
opportune moment to consider what we'd like to do in future.

I'd err myself towards markdown as it preserves the simple text readability 
whilst being flexible and having simple editor support

Reply via email to