This is the exciting saga of an adventurous explorer who, with great trepidation, traversed the arid Adobe Outback, through the darkness of Total Eclipse, to emerge, caked in Scrum, scarred, beaten, bruised, yet Agile, where the tributaries Collaboration, Knowledge Capital, and Information coursed the Straits of Budget to witness him navigate joyous and thankful to the delta of the Great Confluence.
Atlassian Summit 2012 - Immigration to Confluence: A Journey Through Foreign Customs
1. Immigration to Confluence
A Journey Through Foreign Customs
Kelly M. McDaniel
Information Developer III Rockwell Software
(Senior Technical Writer) Austin, Texas
2. History
FrameMaker
Bound books and PDFs
Desired single-source, re-use,
standards-based
9. Eclipse to Confluence –
Confluence to EclipseHelp
• Authoring in Eclipse to
produce EclipseHelp
• Authoring in Confluence to
produce EclipseHelp using
Scroll Wiki Exporter plug-in
10. Tools for Wiki-based Documentation
…solutions that make documentation easier,
so everyone can contribute information,
and track the process.
Scroll Wiki Exporter for EclipseHelp
RCP applications or deploy to InfoCenter.
11. K15t Scroll Wiki Exporter
Confluence EclipseHelp (.jar)
No animation, sorry.
12.
13.
14.
15.
16.
17. Enough scrummy
adventure! I’m
hittin’ the shower!
Crikey!
Wrong slide!
H
20. Confluence as an Authoring Tool
Design, author, edit product documentation, release notes, and
installation guide.
• EclipseHelp – via Scroll Wiki Exporter for EclipseHelp (K15t)
• PDF Installation Guide – via native PDF export feature
• HTML - via native HTML export feature
21. Benefits Oh boy!
• Text files • Stable More
no proprietary binaries *nix bullets!!!
• Markup • Fast/Efficient
anyone can fix an issue
standards-based
• Collaboration
• Logical Development Space
easy to teach new authors
• Jira Integration
• Customizable
plugins: Atlassian, 3rd party,
User Community, RYO
Introduce me. (click)Technical WriterFrameMaker? Conversion? Breaking up with FrameMaker.How many currently using Confluence?How many considering or will switch Confluence soon?I found the trip to be, not so much a migration as an immigration…seems like a whole different country.(click)
From FrameMakerHigh acquisition costSteep learning curveQuirky and proprietary (binaries)Using Mif2Go - one-time conversionDesired single-source, re-use, standards-based solution********************This is the exciting saga of an adventurous explorer who, with great trepidation, traversed the Arid Adobe Outback, through the darkness of Total Eclipse, to emerge, caked in Scrum, scarred, beaten, bruised, yet Agile, where the tributaries Collaboration, Knowledge Capital, and Information coursed the Straits of Budget to witness him navigate joyous and thankful to the delta of the Great Confluence.“So our explorer (click)was feeling adventurous…”
So he set out (click)with great trepidation …
…to traverse the Arid Adobe Outback. (click)
…and in this strange land, he encountered many peculiar foreign customs …(click)
Which he found to beunnecessarily complex,with its own language and idiosyncrasies whereRoboNoHelp-to-FrameBreaker conversions were clumsy,PDF mods were too time-consuming, and the (click)Technical Communications Suitewas just much-too-much.…so he traveled through the darkness of Total Eclipse…(click)
The conversion from FrameMaker to Eclipse was painful, and the book structure remained.Using Eclipse to write and produce documentation in a manual build process tocreate EclipseHelp jar files (click) for his RCP application.
He immigrated from (click)Eclipse to Confluence so he could go from Confluence to EclipseHelp.(click)
He converted his Eclipse files to Confluence and now authors in Confluence to produce EclipseHelp using the Scroll Wiki Exporter from K15t Software. (click)………………..…and just a few words about K15t software.(click)
K15t builds tools and solutions that make documentation easier, so everyone can contribute information, (click)and track the process(click)The EclipseHelp exporter produces files that can be embedded in RCP applications or deployed to InfoCenter.(click)TheK15t team are Atlassian Experts.(click)
We use the exporter to take Confluence content and roll it up into EclipseHelp (a jar file).(click)
After I installed the plug-in,I found a new option in the Confluence > Tools menu, "Export to EclipseHelp." This link opens an export configuration wizard.(click)
And it looked like this.General: I used the Default Eclipse Template, (click)
and “This page and its children” (export the parent/top-level topic and all child topics.) I specified the balance of the export options, exported to jar files, l and added the jars in my product build process. (See the K15t folks for detail on the other export options.)(click)
After I configured and exported the Confluence content, I saved my export settings as “MyEclipseExport.”This is where all your settings are saved so you can use them again without a reconfig. Not being a very creative guy, I used “MyEclipseExport.” You can name them something significant to your process.Later, to automate the export, (click)I clicked the character to the right of the settings name. This opened a REST URL window with the parent page URL plus a unique ID string that retains all the configuration information.(click)
We use Bamboo in our build process, so I created credentials for Bamboo, and added this URL to our Bamboo automated product build.(click)This is the complete URL including the parent page ID. We run a post-export regular expression to customize the jars.…so our adventurous explorer emerged, caked in scrum…(click)
…scarred, beaten, bruised, yet Agile (click)
He coursed the Straits of Budget…(click)
…where the tributaries Collaboration, Knowledge Capital, and Information flow……to navigate to the Delta of the Great Confluence.(slide)
So he now uses Confluence to design, author, edit product documentation, release notes, and an installation guideusing the Scroll Wiki Exporter for EclipseHelp in an automated build process.(click)
Text files - no proprietary binariesMarkup - standards-basedLogical - easy to teach new authorsCustomizable - plugins: Atlassian, 3rd party, User CommunityStable - *nixFast/Efficient - anyone can fix an issueCollaboration - Development SpaceJira Integration(click)
Low acquisition costEasy to ImplementConfigurable - Adaptable to our needs.Scalable - could not be a constraint(click)
All this is possible with Confluence because of the solutions from K15t Software, Official Sponsors of Summit 2012. Be sure to stop by the K15t booth. Sie sind großartige Leute!And remember, “Confluence is a great adventure”(click)
My name is Kelly McDaniel and this has been the story of“Immigration to Confluence: A Journey Through Foreign Customs”(click)