Ce diaporama a bien été signalé.
Nous utilisons votre profil LinkedIn et vos données d’activité pour vous proposer des publicités personnalisées et pertinentes. Vous pouvez changer vos préférences de publicités à tout moment.

Documentation brought to life: Asciidoctor & Gradle (Greach 2015)

2 963 vues

Publié le

Slides from the talk "Documentation brought to life: Asciidoctor & Gradle" at Greach 2015
find examples at https://github.com/madmas/AsciidoctorGradle-Doc2Life

  • Hey guys! Who wants to chat with me? More photos with me here 👉 http://www.bit.ly/katekoxx
       Répondre 
    Voulez-vous vraiment ?  Oui  Non
    Votre message apparaîtra ici

Documentation brought to life: Asciidoctor & Gradle (Greach 2015)

  1. 1. Documentation brought to life: Asciidoctor St Gradle Markus Schlichting
  2. 2. :3 Markus Schlichting delivering end-user happiness
  3. 3. Overview
  4. 4. Overview Current situation
  5. 5. Overview AsciiDoc(tor)
  6. 6. Overview Gradle
  7. 7. Overview Combined powers (Demo! )
  8. 8. Overview Living documentation (Demo! )
  9. 9. Overview Additional boosts
  10. 10. We write documentation with systems that drive us crazy
  11. 11. .iXT_[)]_| i 1 15
  12. 12. ASCIiDOC ; AIIn HZ . . . .. .m‘: .:: t:: :: .,= f:, :22r@:2.. .mn_w"e AscIIDoc Is Wrltlng Zen 1150"‘! “Di rm ’'nrm (inc vrrier@eample cnm _Zen_ in the *art* of writing ‘glam text‘ with htw: //asciidoc -oreiAs= iiD0=l- Zen in the art ofwriting plain text With AsciiDoc. [TIP] "59 ! “‘P1/’35‘ii“°“°"‘°"9["5°ii"°“°’1 ‘°' "'9 be“ “5‘i1“°° Q | mscrmouo| 'iu| ‘livri)uxl. rni)oL«-xpc1'rmILr“ ilw-nv. li>ourrI‘ experience. fontnote: [Nut to mention the best looking output! ) Then icon: twitter[ro'le= aqua] about it! = = Sample Section Sample Section [square] * item 1 . rremr " item 2 -rremz [source, ruby] puts "He1'lu, Wur1r.1“‘ puts Hello, World‘ 1 Nm (0 rnenlmn me best looking onumn Asr-_i. iDuc source Rendered HTML
  13. 13. AsciiDoc ll” , l ASCHDOC lS Writing Zen / rmmum-nrrh: warm J nu» lLrrllll , l 9 l’] 1 A»c1lIJnc xullrcc llerrclcrecl IlT. II, l O l C Use AsciiDoc for document marlrup. It's actually readable by lrumans, easier to parse and more flexible tlran XML — L. Torvalds
  14. 14. Kiifljiyigjwr
  15. 15. AsciiDoctor modern impl. of AsciiDoc with Ruby
  16. 16. AsciiDoctor I-. ’ n 1 _' 4.» , imn. .. . ,s. uh. .. I’ easily useable on Jlllvi using JRuby
  17. 17. AsciiDoctor supports extensions
  18. 18. AsciiDoctor many output formats PDF, eBoolr HTMl5 everything else (-> DocBooh)
  19. 19. AsciiDoctor maintainable Tables with Ascii or CSV
  20. 20. .il1.'iii. 'l! IL‘. i1Li' . r.r. nIIji: -l. I,r. Ii. r,IJgll. !i_i‘_: X1!l11Ji! IC*. 'iii. i.I. li! lii'/ 1-l'-. b.i1)_'l'! b_i? i': l,)l, l?'! l,l, L:mWlhfllbf) : l:is! Ihi/ u! Ipg1_»1.r, '+fi- :4s: .r'_'r: nrils1sir. ~: srsr_hI. r1'/ ”r1!iig1!ii"‘iu. Isrr, hi. i¢; _'. iJi: ;:4_: i.i.1:i illbib alrnuimiiigaqsiiaie . mn_: m»1;‘i) nhiisri ihiisrrhlllsla’ 111.5] li—h‘T Yliii i Lsilxifill ! ll” Cfill : ,: isnur_i. i_-ism:
  21. 21. Where Documentation Writing Sr publishing boohs Presentations (dech. js, revea| .js, DZS| ides)
  22. 22. the upcoming build system b for the JVM ecosystem (Sr beyond)
  23. 23. GRADLE: SAMPLE apply plugin: 'java' apply plugin: 'application' mainClassName 'sample. Foo' version = '0.0.0—SNAPSHOT' group = 'com. canoo' repositories { jcenter() } dependencies { compile 'commons—lang: commons—lang:2.6' testcompile 'junit: junit:4.11'
  24. 24. power: AsciiDoctor Sr Gradle
  25. 25. Worhflow: daily business
  26. 26. Worhflow: daily business Gradle watch tash
  27. 27. Worhflow: daily business Version i«! umber integration
  28. 28. Worhflow: daily business Tested snippets in documentation
  29. 29. Worhflow: git adds superpowers!
  30. 30. Worhflow: git adds superpowers! Split and structure your documention -tr apply DRY
  31. 31. Worhflow: git adds superpowers! pull / merge requests! -= * easier envolvement with progress in development
  32. 32. Worhflow: git adds superpowers! plays well with feature branches
  33. 33. Worhflow: git adds superpowers! Integrate with releases and generate the correct documentation
  34. 34. Creation l‘r: '_'f: “_' ". :f. Ife c. 'I1: | ntel| iJ IDEA Plugin Eclipse: jbosstools-asciidoctor Firefox plugin Chrome plugin
  35. 35. Specification by Example Sr living Documentation [II II) Til II!
  36. 36. Additional power: Diagrams - P| antUMl - Ditaa - Shaape - B| ocllDiag, SeqDiag. ActDiag, NwDiag - liraphVizDOT simple diagram
  37. 37. Get started Asciidoctor Gradle lazybones Template: lazybones create asciidoctor—gradle <yourProjectName>
  38. 38. Thank you! Questions ? a.4~—aa-our 4 l 4 4 cogs ' '1eL. .S Sci "J '!9n “,3 Inhanihua n. .snn~. n. 0 [delivering and-user happiness] . .:~-. .., ,. .I --.4 -T-. ,.. .r~. -.. , . A I| unlhuu, tuDh-llilhlhuun. .. ... ..3.c. ..': i “- . ... »|~». ... . .n. .u. nn. u
  39. 39. Resources on | n II | -o-aw »; --_----: -_'up—-r ‘ 1_cu~v-nr «IS uéhllnunwfitb -uufivmnfl IiOlI. .,pIu ['. ... ... .. . -L, . f. ..4-9.. ., - . ... :'- «r . m.. ..«. .E luv Z. ” 8 Iuun-_a ’I$6lIww‘ -.1-p--"Na '. n'~' rvlmatillfla --an. :.». ¢ A«‘. u ia. uuurhaIb ”"~»». 1"’ ' Fm-Len‘. M» Jv"V'. “(‘ . ',. . l s r. ':. ... t r '‘ nun badwannuu undunnsvwfiirw - on Q n 0 f lg F4-pm "fil rQrT~flL3r an «sunny, has-nuuubv -I. Iuvu Invoguvpczt -‘A--. I" -"4 . ..! -I] . ... .—L. .. ... I. '. ... !"~-. »-. .. I. ... u.. lSh. ..3 .4»: Iv. “ . JF. ... SC: i . ... ..--. .;. .. I I r7: ',, l. I-, .,"«. ,., K, .. .,. .L'. ,.. J r, ... -.. ,, bun e. ... .vnw». nu Iuunnbul Laue. ..’
  40. 40. "In

×