- #BALSAMIQ WIREFRAMES CONFLUENCE HOW TO#
- #BALSAMIQ WIREFRAMES CONFLUENCE GENERATOR#
- #BALSAMIQ WIREFRAMES CONFLUENCE UPDATE#
- #BALSAMIQ WIREFRAMES CONFLUENCE CODE#
It takes a bit of math to do it, but that's what computers are good at anyway.Īnd now to that "Getting Started" section at the top. It then creates the number of items in each column so that they are as even as possible. From there Hugo counts the number of remaining articles and divides that number by 3 (rounded up to the nearest whole number). The variable called $featuredRows helps determine where the count should start for columns. Instead of changing file formats, we leveraged the flexibility of Hugo to use the meta data (front matter) from the Markdown file as a trigger to tell Hugo to insert content from one file to another. The end result was that users could now find the information where they expected to find it.
#BALSAMIQ WIREFRAMES CONFLUENCE CODE#
This code inside one of the Hugo templates allowed us to put help files in two hidden folders (called "_v2" and "_v3") that would get injected into files across multiple documentation folders each time the site was generated. I enlisted the help of our resident Go expert, Luis, and he wrote some code to do just what we wanted. I like how simple Markdown is and I wanted to see if we could achieve what we wanted without abandoning it. But, I'm stubborn (and Hugo doesn't support them well). We wanted to be able to write the docs once and have them show up across multiple versions.Ī simple solution, I suppose, would have been to switch from Markdown to a file format that supports including content from one file in another (like reStructuredText or AsciiDoc). We wanted a complete set of docs for each product version and platform.īut, of course, we didn't want to maintain seven copies of each article.
#BALSAMIQ WIREFRAMES CONFLUENCE UPDATE#
This is what the content folder in our GitHub repo looked like, which meant that a lot of customers had this experience:įor the next update to our docs, we decided that we needed to finally address this issue. If you used our product on a different platform, you had to know to go to the Desktop docs. So, seven products that we sell, but only two main sets of documentation.įor historical reasons, most of the common documentation is in the Desktop version docs. Very little has to do with platform-specific features.
#BALSAMIQ WIREFRAMES CONFLUENCE HOW TO#
The majority of our documentation is how to use one of the two core wireframe editors. This is great for our customers, but a challenge for our docs. That's seven different products that we sell, catered to different types of users. There are two versions of the core product (the wireframe editor) that are sold as: a stand-alone desktop version, a hosted web version ("myBalsamiq"), and plugins for Google Drive and Atlassian Confluence and JIRA. Our product, Balsamiq Mockups, comes in multiple "flavors," as we often call them. Challenge #1: Documenting multiple product versions
#BALSAMIQ WIREFRAMES CONFLUENCE GENERATOR#
Note: The code in this article is specific to Hugo, the static site generator we use, but should be adaptable to others. This is a story of three challenges and how we solved them. It was a long process and we were happy just to see it up and running.Īfter the dust settled, we started imagining what we wanted for the next version, and realized that the system we had built had limitations that we would have to overcome. BackgroundĪ year and a half ago we ditched our flaky content management system and converted our documentation site over to a "docs like code" system using Hugo, Gulp, and GitHub, with content written in Markdown.
Leon Barnard, Designer and Writer (and Developer-in-training) at Balsamiq, describes how the second version of the Balsamiq Docs static site went beyond purely functional to do things the team didn't think Markdown and static sites could do. Case Study - Balsamiq Docs: Static Doesn't Have to Be a Limitation
0 kommentar(er)
