220 lines
14 KiB
HTML
220 lines
14 KiB
HTML
<!DOCTYPE html>
|
||
<html class="no-js" lang="en">
|
||
<head>
|
||
<title>Confluence upload - DAUX.IO</title>
|
||
<meta name="description" content="The Easiest Way To Document Your Project">
|
||
<meta name="author" content="Stéphane Goetz">
|
||
<meta charset="UTF-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
||
<link rel="icon" href="../themes/daux/img/favicon-blue.png" type="image/x-icon">
|
||
|
||
<!-- Mobile -->
|
||
<meta name="apple-mobile-web-app-capable" content="yes" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<!-- Font -->
|
||
|
||
<!-- CSS -->
|
||
<link href='../themes/daux/css/theme-blue.min.css' rel='stylesheet' type='text/css'>
|
||
<!-- Tipue Search -->
|
||
<link href="../tipuesearch/tipuesearch.css" rel="stylesheet">
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="../themes/daux/js/html5shiv-3.7.3.min.js"></script>
|
||
<![endif]-->
|
||
</head>
|
||
<body class="with-float ">
|
||
<div class="Columns content">
|
||
<aside class="Columns__left Collapsible">
|
||
<button type="button" class="Button Collapsible__trigger">
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
<span class="Collapsible__trigger__bar"></span>
|
||
</button>
|
||
|
||
<a class="Brand" href="../index.html">DAUX.IO</a>
|
||
|
||
<div class="Search">
|
||
<svg class="Search__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 451 451">
|
||
<path d="M447.05 428l-109.6-109.6c29.4-33.8 47.2-77.9 47.2-126.1C384.65 86.2 298.35 0 192.35 0 86.25 0 .05 86.3.05 192.3s86.3 192.3 192.3 192.3c48.2 0 92.3-17.8 126.1-47.2L428.05 447c2.6 2.6 6.1 4 9.5 4s6.9-1.3 9.5-4c5.2-5.2 5.2-13.8 0-19zM26.95 192.3c0-91.2 74.2-165.3 165.3-165.3 91.2 0 165.3 74.2 165.3 165.3s-74.1 165.4-165.3 165.4c-91.1 0-165.3-74.2-165.3-165.4z"/>
|
||
</svg>
|
||
<input type="search" id="tipue_search_input" class="Search__field" placeholder="Search..." autocomplete="on"
|
||
results=25 autosave=text_search>
|
||
</div>
|
||
|
||
<div class="Collapsible__content">
|
||
<!-- Navigation -->
|
||
<ul class='Nav'><li class='Nav__item '><a href="../Getting_Started.html">Getting Started</a></li><li class='Nav__item has-children'><a href="../Features/Auto_Syntax_Highlight.html" class="folder"><i class="Nav__arrow"> </i>Features</a><ul class='Nav'><li class='Nav__item '><a href="../Features/Auto_Syntax_Highlight.html">Auto Syntax Highlight</a></li><li class='Nav__item '><a href="../Features/CommonMark_compliant.html">CommonMark compliant</a></li><li class='Nav__item '><a href="../Features/Edit_on_GitHub_links.html">Edit on GitHub links</a></li><li class='Nav__item '><a href="../Features/Front_Matter.html">Front Matter</a></li><li class='Nav__item '><a href="../Features/Internal_links.html">Internal links</a></li><li class='Nav__item '><a href="../Features/Landing_page.html">Landing page</a></li><li class='Nav__item '><a href="../Features/Live_mode.html">Live mode</a></li><li class='Nav__item '><a href="../Features/Multilanguage.html">Multilanguage</a></li><li class='Nav__item '><a href="../Features/Multiple_Output_Formats.html">Multiple Output Formats</a></li><li class='Nav__item '><a href="../Features/Navigation_and_Sorting.html">Navigation and Sorting</a></li><li class='Nav__item '><a href="../Features/Search.html">Search</a></li><li class='Nav__item '><a href="../Features/Static_Site_Generation.html">Static Site Generation</a></li><li class='Nav__item '><a href="../Features/Table_of_contents.html">Table of contents</a></li></ul></li><li class='Nav__item has-children'><a href="../Examples/index.html" class="folder"><i class="Nav__arrow"> </i>Examples</a><ul class='Nav'><li class='Nav__item '><a href="../Examples/Code_Highlighting.html">Code Highlighting</a></li><li class='Nav__item '><a href="../Examples/Hello_World.html">Hello World</a></li><li class='Nav__item '><a href="../Examples/Hello_World_de.html">Hallo Welt</a></li><li class='Nav__item '><a href="../Examples/привет_мир.html">привет мир</a></li><li class='Nav__item '><a href="../Examples/你好世界.html">你好世界</a></li></ul></li><li class='Nav__item Nav__item--open has-children'><a href="../Configuration/index.html" class="folder"><i class="Nav__arrow"> </i>Configuration</a><ul class='Nav'><li class='Nav__item Nav__item--active'><a href="../Configuration/Confluence_upload.html">Confluence upload</a></li><li class='Nav__item '><a href="../Configuration/Html_export.html">Html export</a></li></ul></li><li class='Nav__item has-children'><a href="../For_Developers/Creating_a_Processor.html" class="folder"><i class="Nav__arrow"> </i>For Developers</a><ul class='Nav'><li class='Nav__item '><a href="../For_Developers/Creating_a_Processor.html">Creating a Processor</a></li><li class='Nav__item '><a href="../For_Developers/Creating_a_Theme.html">Creating a Theme</a></li></ul></li></ul>
|
||
|
||
<div class="Links">
|
||
<hr/>
|
||
<a href="https://github.com/dauxio/daux.io/archive/master.zip" target="_blank">Download</a>
|
||
<br />
|
||
<a href="https://github.com/dauxio/daux.io" target="_blank">GitHub Repo</a>
|
||
<br />
|
||
<a href="https://github.com/dauxio/daux.io/issues" target="_blank">Help/Support/Bugs</a>
|
||
<br />
|
||
</div>
|
||
|
||
<div class="CodeToggler">
|
||
<hr/>
|
||
<span class="CodeToggler__text">Code blocks</span>
|
||
<div class="ButtonGroup" role="group">
|
||
<button class="Button Button--default Button--small CodeToggler__button CodeToggler__button--hide">No</button>
|
||
<button class="Button Button--default Button--small CodeToggler__button CodeToggler__button--below">Below</button>
|
||
<button class="Button Button--default Button--small CodeToggler__button CodeToggler__button--float">Inline</button>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="Twitter">
|
||
<hr/>
|
||
<iframe allowtransparency="true" frameborder="0" scrolling="no" style="width:162px; height:20px;" src="https://platform.twitter.com/widgets/follow_button.html?screen_name=onigoetz&show_count=false"></iframe>
|
||
<br />
|
||
<br />
|
||
</div>
|
||
|
||
<div class="PoweredBy">
|
||
<hr/>
|
||
Powered by Daux.io </div>
|
||
</div>
|
||
</aside>
|
||
<div class="Columns__right Columns__right--float">
|
||
<div class="Columns__right__content">
|
||
<div class="doc_content">
|
||
<article class="Page">
|
||
|
||
<div class="Page__header">
|
||
<h1><a href="../Configuration/index.html">Configuration</a> <svg class="Page__header--separator" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 477.175 477.175"><path d="M360.73 229.075l-225.1-225.1c-5.3-5.3-13.8-5.3-19.1 0s-5.3 13.8 0 19.1l215.5 215.5-215.5 215.5c-5.3 5.3-5.3 13.8 0 19.1 2.6 2.6 6.1 4 9.5 4 3.4 0 6.9-1.3 9.5-4l225.1-225.1c5.3-5.2 5.3-13.8.1-19z"/></svg> <a href="../Configuration/Confluence_upload.html">Confluence upload</a></h1>
|
||
<span class="ModifiedDate">
|
||
Thursday, June 7, 2018 11:42 AM </span>
|
||
<span class="EditOn">
|
||
<a href="https://github.com/dauxio/daux.io/blob/master/docs/05_Configuration/Confluence_upload.md" target="_blank">
|
||
Edit on GitHub </a>
|
||
</span>
|
||
</div>
|
||
|
||
<div class="s-content">
|
||
<p><strong>Table of contents</strong></p>
|
||
<div class="TableOfContentsContainer">
|
||
<h4 class="TableOfContentsContainer__title">Table of Contents</h4>
|
||
<div class="TableOfContentsContainer__content">
|
||
<ul class="TableOfContents">
|
||
<li>
|
||
<p><a href="#page_Configuring-the-connection">Configuring the connection</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Where-to-upload">Where to upload</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Prefix">Prefix</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Update-threshold">Update threshold</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Delete-old-pages">Delete old pages</a></p>
|
||
</li>
|
||
<li>
|
||
<p><a href="#page_Information-message">Information message</a></p>
|
||
</li>
|
||
</ul> </div>
|
||
</div>
|
||
<h2 id="page_Configuring-the-connection">Configuring the connection</h2>
|
||
<p>The connection requires three parameters <code>base_url</code>, <code>user</code> and <code>pass</code>. While <code>user</code> and <code>pass</code> don't really need an explanation, for <code>base_url</code> you need to set the path to the server without <code>rest/api</code>, this will be added automatically.</p>
|
||
<pre><code class="language-json">{
|
||
"confluence": {
|
||
"base_url": "http://my_confluence_server.com/",
|
||
"user" : "my_username",
|
||
"pass" : "my_password"
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h2 id="page_Where-to-upload">Where to upload</h2>
|
||
<p>Now that the connection is defined, you need to tell it where you want your documentation to be uploaded.</p>
|
||
<p>For that you need a <code>space_id</code> (name that appears at the beginning of the urls) and an <code>ancestor_id</code>; the id of the page that will be the parent of the documentation's homepage.</p>
|
||
<p>You can obtain the <code>ancestor_id</code> id by editing the page you want to define as a parent: the ID is at the end of the URL</p>
|
||
<pre><code class="language-json">{
|
||
"confluence": {
|
||
"space_id": "my_space",
|
||
"ancestor_id": 50370632
|
||
}
|
||
}
|
||
</code></pre>
|
||
<p>You can also provide a <code>root_id</code> instead of an <code>ancestor_id</code> in this case, you specify the id as the homepage of your documentation.</p>
|
||
<p>You can use that when you're uploading your documentation to the root of a Confluence Space or if your page already exists.</p>
|
||
<h2 id="page_Prefix">Prefix</h2>
|
||
<p>Because confluence can't have two pages with the same name in a space, I recommend you define a prefix for your pages.</p>
|
||
<pre><code class="language-json">{
|
||
"confluence": { "prefix": "DAUX -" }
|
||
}
|
||
</code></pre>
|
||
<h2 id="page_Update-threshold">Update threshold</h2>
|
||
<p>To make the upload quicker, we try to determine if a page changed or not, first with a strict comparison and if it's not completely identical, we compute the difference.</p>
|
||
<pre><code class="language-json">{
|
||
"confluence": { "update_threshold": 1 }
|
||
}
|
||
</code></pre>
|
||
<p>If you set <code>update_threshold</code> to 1, it will upload only if the page has more than 1% difference with the previous one.</p>
|
||
<p>By default the threshold is 2%.</p>
|
||
<p>Setting the value to <code>0</code> disables the feature altogether.</p>
|
||
<h2 id="page_Delete-old-pages">Delete old pages</h2>
|
||
<p>When a page is renamed, there is no way to tell it was renamed, so when uploading to Confluence, the page will be uploaded and the old page will stay here.</p>
|
||
<p>By default, it will inform you that some pages aren't needed anymore and you can delete them by hand.</p>
|
||
<pre><code class="language-json">{
|
||
"confluence": { "delete": true }
|
||
}
|
||
</code></pre>
|
||
<p>By setting <code>delete</code> to <code>true</code> (or running <code>daux</code> with the <code>--delete</code> flag) you tell the generator that it can safely delete the pages.</p>
|
||
<h2 id="page_Information-message">Information message</h2>
|
||
<p>When you create your page. there is no indication that the upload process will override the content of the pages.</p>
|
||
<p>It happens sometimes that users edit the pages to add / fix an information.</p>
|
||
<p>You can add a text in a "information" macro on top of the document by setting the following configuration :</p>
|
||
<pre><code class="language-json">{
|
||
"confluence": {
|
||
"header": "These pages are updated automatically, your changes will be overriden."
|
||
}
|
||
}
|
||
</code></pre>
|
||
<p>It will look like this :</p>
|
||
<p><img src="info_macro.png" alt="Info macro" /></p>
|
||
</div>
|
||
|
||
<nav>
|
||
<ul class="Pager">
|
||
<li class=Pager--prev><a href="../Configuration/index.html">Previous</a></li> <li class=Pager--next><a href="../Configuration/Html_export.html">Next</a></li> </ul>
|
||
</nav>
|
||
</article>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||
|
||
ga('create', 'UA-3551397-7', '');
|
||
ga('send', 'pageview');
|
||
</script>
|
||
|
||
<!-- JS -->
|
||
<script src="../themes/daux/js/jquery-1.11.3.min.js"></script><script src="../themes/daux/js/highlight.pack.js"></script><script src="../themes/daux/js/daux.js"></script>
|
||
<!-- Tipue Search -->
|
||
<script type="text/javascript" src="../tipuesearch/tipuesearch.js"></script>
|
||
|
||
<script>
|
||
window.onunload = function(){}; // force $(document).ready to be called on back/forward navigation in firefox
|
||
$(function() {
|
||
tipuesearch({
|
||
'base_url': '../'
|
||
});
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html>
|