Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

16
PRESENTED BY Hands-on with Source Control: Using Flare with a Cloud Source Control Provider Paul Pehrson DocGuy Training | @docguy | www.docguy.training Advanced Workshop

Transcript of Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Page 1: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

PRESENTED BY

Hands-on with Source Control:Using Flare with a Cloud Source Control Provider

Paul PehrsonDocGuy Training | @docguy | www.docguy.training

Advance

d Works

hop

Page 2: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

About Me• (Ab)using Flare for 10

years• Full time technical writer

at Venafi• Part time Flare consultant

and trainer at DocGuy Training

Page 3: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Let’s talk source control

Page 4: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

What benefits does source control give me?

• Project is backed up. Forever.• Multiple writers, one project.• Version tracking that matches your product.• UNDO! Oh Crap!

(i.e. Why do I care?)

Page 5: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Begin with the

in mind

Image Credit: Mike Wolpert

Page 6: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Step 1: Pick a Source Control Provider• Flare connects with the following source control

providers natively:– Subversion (SVN)– GIT– Microsoft Team Foundation Server (TFS)– Microsoft Visual Source Save (VSS)– Perforce

Page 7: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Step 2: Figure Out Where Your Database Is• Dev group?• Cloud provider• Set up your own

Page 8: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Step 3: Configure CloudForge1. Go to www.cloudforge.com2. Click Login3. Enter the username and password assigned to you4. Create a Project5. Choose SVN (to minimize questions today)

Page 9: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Step 4: Configure Flare1. Visit

http://www.docguy.training/MW2016/SampleSourceControl.flprjzip

2. Locate the download on your computer and double-click it to open it in Flare

3. Open Project Properties4. On Source Control tab, Bind Project…5. Use options from CloudForge, and click Okay.

Page 10: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider
Page 11: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider
Page 12: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Step 5: Day-to-Day Operations• Update the Project• Modify files• Check in files• Lock a file• Source Control settings in Flare

Page 13: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Administration• Add users• Review revision history• Resolve conflicts

Page 14: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

How GIT is different• Local commits vs. pushing to the server• Better option if you work offline frequently• Better for smaller doc teams (fewer merge conflicts)• Doesn’t allow you to ‘lock’ files, which makes for more

merge conflict potential than SVN

Page 15: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Q&A

Page 16: Hands-on with Source Control: Using MadCap Flare with a Cloud Source Control Provider

Thank You!

Visit my website for more information on consulting and training opportunities

www.docguy.training