Confluence, a Great IT Documentation Tool

Introduction

Years ago, I was the new system administrator at the company. I had to get a handle on the multitude of systems, servers and software. My predecessors did a great job of documenting the details in Microsoft Word. Because of the number of documents it was hard to find stuff. It was time consuming to keep details up to date as software and systems changed.

Then I discovered MediaWiki, the Open Source software that runs Wikipedia. An old donated PC was host for Linux and MediaWiki. I copied the Word documents into the wiki. It was easy and natural (for me at least) to build easy to navigate links to the IT documentation. MediaWiki keeps older versions so it is easy to see the history of changes. Wiki markup is weird and unnatural to normal people but a few folks at the company took to it. The help was welcome for maintaining the IT processes and procedures. Contributors logged in to MediaWiki so we could see who made changes.

Unlike the Word documents it was easy to search and find information. We could email hyperlinks to folks in need of support. That saved time for me and other power users. And normal folks would some times let us know when documentation was out of date or wrong. MediaWiki reduced the friction of sharing and managing the documentation.

I looked at SharePoint a few times. SharePoint is well integrated with Windows and Microsoft Office products. It seems like a natural extension for folks familiar with that world. SharePoint’s wiki didn’t work for me though. And the easy extensibility worked against using it for documentation. That lead to a lot of rabbit holes to get lost in when the focus should be elsewhere. Don’t get me wrong, I am very good in the Microsoft world but it felt like more friction to get things done.

Atlassian Confluence

I came across Atlassian Confluence while exploring Agile development methods. Confluence is like a polished MediaWiki.

Working together on documentation is well thought out. Instead of emailing the author about changes a user selects text on the Confluence page. A popup presents the user with the option to comment right on the page. Comments are part of the documentation. That is much better than email silos.

The real time collaboration is great. When more than one user edits a page at the same time the changes synchronize between them in real time.

Like MediaWiki, Confluence keeps track of previous versions of the pages. Having that history gives users more confidence. They do not have to maintain many copies of a document. The history is all right there with that page in Confluence.

Embedding and attaching pictures is easy in Confluence. Users can also attach Word, Excel, PDFs and other files.

A cool plugin for Confluence is Gliffy. It is like a web based Visio for creating diagrams, flowcharts and so forth. Many times IT documentation is better with a network diagram or a business workflow. The Gliffy plugin tracks versions as well. Users have that history of changes which helps with complex diagrams.

Confluence benefits from tight integration with Atlassian JIRA. That is good if you use JIRA. JIRA is an issue tracking tool that is great for software development. Many use JIRA for business project management and managing service.

Confluence and JIRA are both available as cloud services from Atlassian. No servers to maintain.

Having time on my hands I went with installing Confluence and JIRA on my servers. Well, actually Hyper-V virtual machines running Linux. The install process is well documented. I ran into a few problems but Atlassian had intuitive help to get through them. The price made me smile. My self-hosted servers were $10 each for 10 users. That’s a good value and a low barrier for these tools.

Confluence helps my efficiency with the DRY principle (Don’t Repeat Yourself). Having the notes and documentation online means they’re available almost everywhere. And Confluence reduces the friction of maintaining documentation.

After upgrading Confluence, you are unable to create new pages or spaces

Bogus Adobe Acrobat Reader update notifications?

Each time I open a PDF document in Acrobat Reader Adobe a warning pops up. The warning claims Acrobat Reader is out of date…etc. This is strange. I choose not to have Adobe notifications.  This is an Adobe warning.  I tracked it down with the SysInternals Process Explorer.  It seems Adobe doesn’t respect my choices.
 
I visit Adobe’s website for the Reader update and choose the latest version. The warning still pops up with the latest available Adobe update. I used the Secunia PSI software checker for several years. PSI is reliable and I had no problems with it. PSI was happy with the version of Reader that Adobe complains about.
 
The bogus Adobe warning pops up on more than one Windows computer. It affects Windows 7, 8, 8.1 and 10. The warning didn’t popup on my Mac but the OS X built-in Preview app handles PDFs by default. The Mac has Adobe Reader installed and out of date (due to lack of use) but there are no warnings.
 
I avoid opening Acrobat files on Windows. Instead I use my iPad or iPhone since they are usually near by. Gmail is great to preview Acrobat files without Adobe.  I understand Google has their own Flash player in Chrome too.  Adobe Flash is also a big security liability.
 
Adobe’s shameful bundling of crapware is another reason to use care. The Adobe download sites default to pushing extra software with updates. Make sure to uncheck stuff like McAfee, Ask toolbars, etc.
 
Considering costs and innocent users affected Adobe may be worse than malware creators.

UPDATE:
 
Adobe’s suggested update is to the same, installed version. During the installation I selected NOT to have Adobe’s notifications. Regardless of my choices Adobe installed Windows Services and Windows Schedule Tasks. The tasks check for updates. I removed the tasks and services. No means no, Adobe.

CAD Drawings to PDF with SolidWorks, eDrawings and VBA

An automated solution to make Acrobat PDF files from CAD drawings. The solution handles SolidWorks and AutoCAD drawings.
 

The problem

 
The company had a solution for plotting engineering drawings.  Employees in production had a fast utility to lookup CAD drawings. There were tens of thousands of drawings.  Printing was a simple button click.  There were no printer dialogs.  No printer choices.  No choosing settings.  Less wasted paper.  It was a huge time and resource saver.  With the upgrade to Windows 7 the supporting engineering tools no longer worked.  The efficient CAD printing no longer worked after the I.T. upgrades.
 

The parts

 
eDrawings is a free utility from SolidWorks.  eDrawings opens SolidWorks and AutoCAD drawing files.  eDrawings updates every year.  eDrawings handles new AutoCAD drawing formats with the updates.  Like most of SolidWorks, you can automate eDrawings.
 
novaPDF is a utility to generate Adobe Acrobat [.PDF] files.  novaPDF is available on Windows computers.
 
Microsoft Access 64bit.  Most use the 32bit versions of MS Access and MS Office.  For this solution we need a 64bit VBA capable container to host the eDrawings component.
 

The solution

 
With novaPDF create some virtual printers.  Create separate printers for each CAD drawing page size and orientation.  For example: ‘B_Size_portrait’, ‘B_Size_landscape’, ‘D_Size_landscape’, ‘C_Size_landscape’.
 
Create a blank MS Access database application.  Add a blank Form without a linked table.  Embed the eDrawings component into the form.  
 
Switch to the VBA editor for the MS Access Form.  The first step is a loop to watch for new SolidWorks or AutoCAD drawing files.  Opening each drawing file in turn.
 
Use the eDrawings component Event functions to handle the file once it opens.  The eDrawings component has properties to detect the drawing paper size and orientation.  Use those properties to choose the matching novaPDF virtual printer and print.
 
Provide error handling for the eDrawings Event functions for problems like corrupt files.  This app rejects undefined paper sizes.  We ran into a problem detecting AutoCAD drawing sizes that used different scales.  The solution was to calculate the size ratio of height to width and use the ratio to select the output paper size.  The MS Access/eDrawings solution becomes unstable after processing 40 to 50 files.  Auto-restarting MS Access after 20 to 30 files solves the problem.
 
This PDF Generator solution runs on a Windows virtual machine.  It averages processing drawing files every three to five seconds with moderate resources.  The solution keeps up with an engineering department of about a dozen.  Well over a hundred thousand legacy CAD files ran through the PDF Generator.
 
There are a few other pieces to the solution.  A lightweight, custom server process provides point and click printing.  A custom web server and front end JavaScript client provides searching and viewing.  The CAD library is now available to desktops, laptops, tablets and smartphones now. There are other, comercial solutions but this preserved the company’s workflow.

LinkedIn worries

The primary reasons LinkedIn is the mustached, trench coat and wire frame glasses wearing mouth breather of the internet are the “People You May Know” and “People Also Viewed” features.

Recently I noticed “People You May Know” displaying plain email addresses instead of LinkedIn profiles.

The plain email accounts do not have actual LinkedIn profiles. My guess is that LinkedIn wants me to try to connect and then send that email address an invite to join LinkedIn.

The creepiest part of it is how LinkedIn is connecting email addresses to my LinkedIn account. I never imported contacts though the prompts appear at nearly every login. I installed the iOS LinkedIn app but never actually launched it (just deleted the LinkedIn app). I use Firefox with No-Script and only allow LinkedIn scripts while on their site.

I do not use LinkedIn much. There are a few subscribed groups with the weekly email digests. After scanning the digests the emails are deleted. Search is only used when the mostly random marketing people or Indians send invites. I check them out.

At what point did LinkedIn go from being cool tech to creepy. A lot of the stuff they were building was interesting from a tech perspective. I guess I’m not liking the direction their heading.