By going to > Page Information, we can see how many incoming links there are to this page, and that tells us how many pages use the image. Doing it this way also allows us to know how many pages we're using the image on. Why do we do use an Include Page macro for one tiny image? Well, just in case that UI element is ever changed. If we attach the image to every page, there might be 50 pages we need to update when things change if we use an Include Page macro, we update once and it's changed everywhere. We have a page with just that image on it, so we can include it whenever we need an ellipsis. Whenever the ellipsis appears in our documentation-for example, go to > Copy-it's actually an Include Page macro. Place each release notes intro in an Excerpt macro, then add an Excerpt Include macro for each set of release notes to the what's new page. Your intros will magically appear on the what's new page, and if you update the release notes it'll automatically update the what's new.Įxcerpts: the intros to these pages are in excerpt macros.Įxcerpt include: these are excerpt include macros.Īnother example is one of the ways we use the Include Page macro. The Include Page macro ( include) to include the entire content of a page on another page.įor example, let's say you create release notes for each major release of your product, and you want to include the intro from each release notes page on a 'what's new' page. The Excerpt Include macro ( excerpt-include) to include the contents of an excerpt on another page. The Excerpt macro to define a re-usable section, or 'excerpt', on a page – add content inside this macro, and you can reuse it on as many pages as you like. There are 3 macros that allow you to re-use content: Inclusions not only save you typing the same thing many times, they also make it easier when things change – it's much better to update the info in one place, than 47! If there's something you're going to use multiple times in your documentation space – whether it's a word, sentence or paragraph an image a product version number or anything else – you can create it once and include it on as many pages as you like (or use it in the header and/or footer). Customize the overview at any time-what it looks like is completely up to you! Select Spaces in the Confluence navigation and select View all spaces and click Create spaceĬhoose Documentation space (it'll give you a custom overview with a search box-the livesearch macro-to search just your documentation space, a recently updated macro, and a few other goodies) and hit NextĬonfluence will automatically create the space key and create the space overview. Below are some tips to help you get your technical documentation site started, and to save you time and effort managing your documentation's life cycle. With this simple configuration, when a user applies the " Add to Knowledge Base" recipe from issue SUP-1, the page creator will display this space and parent page as the target location of the new page.Confluence is a flexible platform with a range of features and add-ons that can help you capture, distribute, and update your technical documentation. In our example, we select " Troubleshooting articles". Configuration stepsġ - As a Jira administrator, go to the " Elements Publish to Confluence" administration and click on Recipes in the navigation bar.Ģ - In the Recipes listing page, select " Add to Knowledge Base" in the Active Recipes list.ģ - In the Recipe configuration page, click on the Target tab.Ĥ - In the " Page context" section, use the Space field to select the target space " Knowledge Base".ĥ - Then, use the Parent page field to select the target parent page among all the existing pages within the space selected in the previous step. PrerequisitesĪ recipe called " Add to Knowledge Base" has been created, activated, and is available on issue SUP-1. This guide explains how to configure the recipe so that all pages created with it will be located under the " Troubleshooting articles" page of the " Knowledge Base" Confluence space. In this example, we will create a Confluence page from an issue with the key SUP-1. With Elements Publish to Confluence, you can select the space and parent page of the Confluence pages that your users will be allowed to create with a recipe, thus making sure that every page gets created exactly where it's supposed to. The bigger the knowledge base grows, the harder it gets to keep it organized. Organizing any type of knowledge base requires users to follow specific rules.
0 Comments
Leave a Reply. |