Modified: brooklyn/site/contributing/index.html URL: http://svn.apache.org/viewvc/brooklyn/site/contributing/index.html?rev=1925014&r1=1925013&r2=1925014&view=diff ============================================================================== --- brooklyn/site/contributing/index.html (original) +++ brooklyn/site/contributing/index.html Fri Apr 11 07:44:54 2025 @@ -25,7 +25,7 @@ <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> -<link href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css"; rel="stylesheet" /> +<link href="/style/deps/bootstrap.min.css" rel="stylesheet" /> <link href="/style/deps/octicons/octicons.css" rel="stylesheet" /> <link href="/style/deps/bootstrap-theme.css" rel="stylesheet" /> <link href="/style/deps/font-awesome-4.2.0/css/font-awesome.min.css" rel="stylesheet" /> @@ -33,7 +33,8 @@ <link href="/style/css/code.css" rel="stylesheet" /> <link href="/style/css/website.css" rel="stylesheet" /> -<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js";></script> +<script type="text/javascript" src="/style/deps/jquery.js"></script> + </head> <body class="page"> @@ -55,11 +56,11 @@ <li class="dropdown"> - <a href="/learnmore/index.html" data-toggle="dropdown">learn more <span class="caret"></span></a> + <a href="/learnmore/" data-toggle="dropdown">learn more <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/learnmore/index.html">Learn More</a> + <a href="/learnmore/">Learn More</a> </li> <li class="divider"></li> @@ -72,7 +73,7 @@ <li > - <a href="/learnmore/features/index.html">Features + <a href="/learnmore/features/">Features </a> </li> @@ -86,7 +87,7 @@ <li > - <a href="/learnmore/catalog/index.html">Browse Catalog + <a href="/learnmore/catalog/">Browse Catalog </a> </li> @@ -98,11 +99,11 @@ <li class="dropdown"> - <a href="/v/latest/start/index.html" data-toggle="dropdown">get started <span class="caret"></span></a> + <a href="/v/latest/start/" data-toggle="dropdown">get started <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/v/latest/start/index.html">Get Started</a> + <a href="/v/latest/start/">Get Started</a> </li> <li class="divider"></li> @@ -148,17 +149,17 @@ <li class="dropdown"> - <a href="/documentation/index.html" data-toggle="dropdown">documentation <span class="caret"></span></a> + <a href="/documentation/" data-toggle="dropdown">documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/documentation/index.html">Documentation</a> + <a href="/documentation/">Documentation</a> </li> <li class="divider"></li> <li class="section"> - <a href="/v/latest/index.html">User Guide + <a href="/v/latest/">User Guide </a> </li> <li class="divider"></li> @@ -172,21 +173,21 @@ <li > - <a href="/v/latest/locations/index.html">Deploying Blueprints + <a href="/v/latest/locations/">Deploying Blueprints </a> </li> <li class="section"> - <a href="/v/latest/ops/index.html">Reference Guide + <a href="/v/latest/ops/">Reference Guide </a> </li> <li class="divider"></li> <li > - <a href="/v/latest/dev/index.html">Developer Guide + <a href="/v/latest/dev/">Developer Guide </a> </li> @@ -212,11 +213,11 @@ <li class="dropdown"> - <a href="/community/index.html" data-toggle="dropdown">community <span class="caret"></span></a> + <a href="/community/" data-toggle="dropdown">community <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/community/index.html">Community</a> + <a href="/community/">Community</a> </li> <li class="divider"></li> @@ -236,7 +237,7 @@ <li > - <a href="/community/security/index.html">Security Advisories + <a href="/community/security/">Security Advisories </a> </li> @@ -257,8 +258,8 @@ <li > - <a href="/community/gsoc.html">Google Summer of Code - </a> + <a href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy Policy + <span class="octicon octicon-link-external"></span></a> </li> @@ -269,17 +270,17 @@ <li class="dropdown"> - <a href="/developers/index.html" data-toggle="dropdown">developers <span class="caret"></span></a> + <a href="/developers/" data-toggle="dropdown">developers <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/developers/index.html">Developers</a> + <a href="/developers/">Developers</a> </li> <li class="divider"></li> <li > - <a href="/developers/code/index.html">Get the Code + <a href="/developers/code/">Get the Code </a> </li> @@ -293,14 +294,14 @@ <li > - <a href="/v/latest/dev/index.html">Developer Guide + <a href="/v/latest/dev/">Developer Guide </a> </li> <li > - <a href="/developers/committers/index.html">Committer Guide + <a href="/developers/committers/">Committer Guide </a> </li> @@ -340,7 +341,7 @@ <li class="dropdown"> - <a href="/download/index.html" class="btn btn-default navbar-btn">download</a> + <a href="/download/" class="btn btn-default navbar-btn">download</a> </li> @@ -361,51 +362,51 @@ which is processed into HTML using <a hr and notation available with these platforms, a number of custom plug-ins have been implemented specifically for the Apache Brooklyn docs. These are detailed below:</p> -<p>Jekyll plug-ins are written in ruby and kept in the <code>_plugins</code> folder. Note that if youâre using <code>jekyll serve</code> to -display the site, changes to these plug-ins will not be reflected in the rendered site until jekyll is restarted. </p> +<p>Jekyll plug-ins are written in ruby and kept in the <code class="language-plaintext highlighter-rouge">_plugins</code> folder. Note that if youâre using <code class="language-plaintext highlighter-rouge">jekyll serve</code> to +display the site, changes to these plug-ins will not be reflected in the rendered site until jekyll is restarted.</p> <h2 id="site-structure">Site Structure</h2> -<p>The site structure and menus are built by a plug-in in <code>site_structure.rb</code>. This plug-in looks in the <a href="https://jekyllrb.com/docs/frontmatter/"; target="_blank">YAML front matter</a> -for child pages to build the structure, and breadcrumbs to determine the parent pages to display. </p> +<p>The site structure and menus are built by a plug-in in <code class="language-plaintext highlighter-rouge">site_structure.rb</code>. This plug-in looks in the <a href="https://jekyllrb.com/docs/frontmatter/"; target="_blank">YAML front matter</a> +for child pages to build the structure, and breadcrumbs to determine the parent pages to display.</p> -<p>Child pages are a list of objects, stored in the field <code>children</code>. These are defined by string path to a file or a YAML -object with a <code>path</code> to another file, or a <code>link</code> to an external URL. In addition a <code>title</code> can be defined +<p>Child pages are a list of objects, stored in the field <code class="language-plaintext highlighter-rouge">children</code>. These are defined by string path to a file or a YAML +object with a <code class="language-plaintext highlighter-rouge">path</code> to another file, or a <code class="language-plaintext highlighter-rouge">link</code> to an external URL. In addition a <code class="language-plaintext highlighter-rouge">title</code> can be defined for the text content of the HTML menu option. See the example below from <a href="https://github.com/apache/brooklyn-docs/blob/master/guide/index.md"; target="_blank">/guide/index.md</a></p> -<div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="l-Scalar-Plain">breadcrumbs</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="l-Scalar-Plain">/website/documentation/index.md</span> -<span class="p-Indicator">-</span> <span class="l-Scalar-Plain">index.md</span> -<span class="l-Scalar-Plain">children</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/start/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/download.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/concepts/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/blueprints/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/java/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/ops/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/index.md</span> <span class="p-Indicator">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">breadcrumbs</span><span class="pi">:</span> +<span class="pi">-</span> <span class="s">/website/documentation/index.md</span> +<span class="pi">-</span> <span class="s">index.md</span> +<span class="na">children</span><span class="pi">:</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/start/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/download.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/concepts/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/blueprints/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/java/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/ops/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/index.md</span> <span class="pi">}</span></code></pre></figure> <h3 id="inline-children">Inline Children</h3> -<p>In addition to the <code>children</code> property defining lower pages in the site structure, they can also be used to define +<p>In addition to the <code class="language-plaintext highlighter-rouge">children</code> property defining lower pages in the site structure, they can also be used to define inline sections within the current document. Inclusion in this way produces a menu link to an anchor in the current page.</p> <p>Below is an example from <a href="https://github.com/apache/brooklyn-docs/blob/master/guide/ops/persistence/index.md"; target="_blank">/guide/ops/persistence/index.md</a>:</p> -<div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="l-Scalar-Plain">children</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Command Line Options</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">File-based Persistence</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Object Store Persistence</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Rebinding to State</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Writing Persistable Code</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Persisted State Backup</span> <span class="p-Indicator">}</span></code></pre></div> - -<p>Inline sections can also be detected from separate, child <code>.md</code> files. Including the tag <code>check_directory_for_children: true</code> -in the YAML front matter of a page causes the site structure plug-in to look through the current directory for any <code>.md</code> files -containing <code>section_type: inline</code> in the YAML front matter.</p> +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">children</span><span class="pi">:</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Command Line Options</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">File-based Persistence</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Object Store Persistence</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Rebinding to State</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Writing Persistable Code</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Persisted State Backup</span> <span class="pi">}</span></code></pre></figure> + +<p>Inline sections can also be detected from separate, child <code class="language-plaintext highlighter-rouge">.md</code> files. Including the tag <code class="language-plaintext highlighter-rouge">check_directory_for_children: true</code> +in the YAML front matter of a page causes the site structure plug-in to look through the current directory for any <code class="language-plaintext highlighter-rouge">.md</code> files +containing <code class="language-plaintext highlighter-rouge">section_type: inline</code> in the YAML front matter.</p> -<p>The content from these inline sections can then be included in the page content using the liquid tag <code>child_content</code>. This is shown below +<p>The content from these inline sections can then be included in the page content using the liquid tag <code class="language-plaintext highlighter-rouge">child_content</code>. This is shown below in an example from <a href="https://github.com/apache/brooklyn-docs/blob/master/guide/locations/index.md"; target="_blank">/guide/locations/index.md</a>:</p> <pre> @@ -435,42 +436,91 @@ can also be set in `provisioning.propert <h3 id="child-page-ordering">Child Page Ordering</h3> -<p>Child pages are by default, ordered by their position in the <code>children</code> YAML front matter field. This can be changed using the property -<code>section_position</code> in the child YAML. For children defined in the front matter this is put in the child object of the <code>children</code> array.</p> +<p>Child pages are by default, ordered by their position in the <code class="language-plaintext highlighter-rouge">children</code> YAML front matter field. This can be changed using the property +<code class="language-plaintext highlighter-rouge">section_position</code> in the child YAML. For children defined in the front matter this is put in the child object of the <code class="language-plaintext highlighter-rouge">children</code> array.</p> -<p>For inline children, sourced using <code>check_directory_for_children: true</code>, this <code>section_position</code> property is put in the child fileâs YAML front matter.</p> +<p>For inline children, sourced using <code class="language-plaintext highlighter-rouge">check_directory_for_children: true</code>, this <code class="language-plaintext highlighter-rouge">section_position</code> property is put in the child fileâs YAML front matter.</p> -<p>The format for <code>section_position</code> is that of software versioning, i.e <code>A.B... Z</code> where A, B etc are numbers of decreasing value. Position <code>1.1.0</code> would appear -before version <code>1.0.4</code> for example. This allows an infinite number of sub pages between each <code>section_position</code>.</p> +<p>The format for <code class="language-plaintext highlighter-rouge">section_position</code> is that of software versioning, i.e <code class="language-plaintext highlighter-rouge">A.B... Z</code> where A, B etc are numbers of decreasing value. Position <code class="language-plaintext highlighter-rouge">1.1.0</code> would appear +before version <code class="language-plaintext highlighter-rouge">1.0.4</code> for example. This allows an infinite number of sub pages between each <code class="language-plaintext highlighter-rouge">section_position</code>.</p> <p>Any un-versioned pages are automatically numbered to add a new minor version from the last page if that was numbered or increment the minor -if it was not. If no pages are yet numbered, the numbering is started at <code>1.1</code>. For example, if a numbered page, <code>1.4</code> is followed by a -non-numbered page, the non-numbered page would be auto-numbered as <code>1.4.1</code>. If this page is followed by another non-numbered page it would -be auto-numbered as <code>1.4.2</code>.</p> +if it was not. If no pages are yet numbered, the numbering is started at <code class="language-plaintext highlighter-rouge">1.1</code>. For example, if a numbered page, <code class="language-plaintext highlighter-rouge">1.4</code> is followed by a +non-numbered page, the non-numbered page would be auto-numbered as <code class="language-plaintext highlighter-rouge">1.4.1</code>. If this page is followed by another non-numbered page it would +be auto-numbered as <code class="language-plaintext highlighter-rouge">1.4.2</code>.</p> <p>For example, a set of children pages numbered like this:</p> -<div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="l-Scalar-Plain">children</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/start/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/download.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/concepts/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/blueprints/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/blueprints/java/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/ops/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/index.md</span> <span class="p-Indicator">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">children</span><span class="pi">:</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/start/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/download.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/concepts/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/blueprints/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/blueprints/java/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/ops/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/index.md</span> <span class="pi">}</span></code></pre></figure> <p>Would end up numbered like this:</p> -<div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="l-Scalar-Plain">children</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/ops/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">2.1</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/start/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/download.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2.1</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/concepts/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2.2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/yaml/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2.3</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/java/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2.4</span> <span class="p-Indicator">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">children</span><span class="pi">:</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/ops/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">2.1</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/start/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/download.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2.1</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/concepts/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2.2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/yaml/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2.3</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/java/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2.4</span> <span class="pi">}</span></code></pre></figure> + +<p>This ordering affects both the position of the child in the html menu and the order of content included with <code class="language-plaintext highlighter-rouge">child_content</code>.</p> + +<h2 id="single-page-manual-and-pdf">Single Page Manual and PDF</h2> + +<p>A single page overview of selections of the site are available in <code class="language-plaintext highlighter-rouge">zoneMergeManual</code> and <code class="language-plaintext highlighter-rouge">zoneMergeStarted</code>. These overviews are for the user manual +and getting started guide respectively. The zone merge pages go through the <a href="/contributing/#site-structure">site structure</a>, described above, and compile the files from this into a +single HTML page.</p> + +<p>In order to do this, each page is iterated over in order and itâs rendered content included in the page. The plug-in <code class="language-plaintext highlighter-rouge">regex_filter.rb</code> is used to re-write + <a> links from the structured site into a form which works on a single page. Links are re-written in the following manner:</p> + +<ul> + <li>If the link is from an external domain, leave it as an unaltered link</li> + <li>If the link is an anchor, convert to the anchor scheme used in the single page</li> + <li>If the link target is in the single page, change the link to point at the anchor in the single page</li> + <li>If the link is pointing at somewhere on the brooklyn site which is not included in this single page, point to the website with a specific version, so https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/start/concept-quickstart.html for instance</li> +</ul> + +<p>In addition, all images srcâs are re-written relative to the root directory.</p> + +<p>Pages can be masked from the compilation process by defining a <code class="language-plaintext highlighter-rouge">page_mask</code> in the YAML front matter of the zone merge file, then including this mask as <code class="language-plaintext highlighter-rouge">true</code> in the child page to exclude. +These pages will then not be included in the compiled single page. Note that this will mask both the child page and any children of this masked page. +For example <a href="https://github.com/apache/brooklyn-docs/blob/master/zoneMergeStarted.html"; target="_blank">zoneMergeStarted</a> uses the mask <code class="language-plaintext highlighter-rouge">started-pdf-exclude</code>:</p> + +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">title</span><span class="pi">:</span> <span class="s">Apache Brooklyn Manual</span> +<span class="na">layout</span><span class="pi">:</span> <span class="s">singlePage</span> +<span class="na">page_mask</span><span class="pi">:</span> <span class="s">started-pdf-exclude</span> +<span class="nn">...</span></code></pre></figure> + +<p>Then in latter pages, such as <a href="https://github.com/apache/brooklyn-docs/blob/master/guide/ops/index.md"; target="_blank">/guide/ops/index.md</a> include <code class="language-plaintext highlighter-rouge">started-pdf-exclude: true</code> to +exclude this section from the getting started guide.</p> + +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">title</span><span class="pi">:</span> <span class="s">Operations</span> +<span class="na">started-pdf-exclude</span><span class="pi">:</span> <span class="no">true</span> +<span class="nn">...</span></code></pre></figure> -<p>This ordering affects both the position of the child in the html menu and the order of content included with <code>child_content</code>.</p> +<p>This will exclude not only the operations page but all of the operations section.</p> + +<p>Specific content can be also be masked or unmasked at a page component level by specifying CSS show and hide classes:</p> + +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">css_hide_class</span><span class="pi">:</span> <span class="s">usermanual-pdf-exclude</span> +<span class="na">css_show_class</span><span class="pi">:</span> <span class="s">usermanual-pdf-include</span></code></pre></figure> + +<p>If the above YAML is included in the front matter of a zone merge file, the classes <code class="language-plaintext highlighter-rouge">usermanual-pdf-exclude</code> and <code class="language-plaintext highlighter-rouge">usermanual-pdf-include</code> will add or remove a +<code class="language-plaintext highlighter-rouge">display: none</code> to a HTML object. In addition the single page theme files <a href="https://github.com/apache/brooklyn-docs/blob/master/_layouts/singlePage.html"; target="_blank">singlePage.html</a> and +<a href="https://github.com/apache/brooklyn-docs/blob/master/style/css/singlePage.css";>singlePage.css</a> can be used to style only the single merged pages.</p> + +<h3 id="conversion-to-pdf">Conversion to PDF</h3> + +<p>These single merged pages are then converted to PDF using wkhtmltopdf in the build scripts of this site.</p> </div> @@ -487,21 +537,28 @@ be auto-numbered as <code>1.4.2</code>.< - <a href="/contributing/index.html#site-structure" class="list-group-item">Site Structure + <a href="/contributing/#site-structure" class="list-group-item">Site Structure + </a> + + + + + + <a href="/contributing/#inline-children" class="list-group-item">Inline Children </a> - <a href="/contributing/index.html#inline-children" class="list-group-item">Inline Children + <a href="/contributing/#child-page-ordering" class="list-group-item">Child Page Ordering </a> - <a href="/contributing/index.html#child-page-ordering" class="list-group-item">Child Page Ordering + <a href="/contributing/#single-page-manual-and-pdf" class="list-group-item">Single Page Manual and PDF </a> @@ -696,8 +753,8 @@ be auto-numbered as <code>1.4.2</code>.< </div> <div class="col-md-3 text-right"> <p> - <a class="btn btn-sm btn-default" href="https://github.com/apache/brooklyn-docs/edit/website/contributing/index.md";>Edit This Page</a> - <a href="https://brooklyn.apache.org/community/how-to-contribute-docs.html"; + <a class="btn btn-sm btn-default" href="https://github.com/apache/brooklyn-docs/edit/master/contributing/index.md";>Edit This Page</a> + <a href="/community/how-to-contribute-docs.html" data-toggle="tooltip" data-placement="top" title="" data-delay="400" data-original-title="How to Edit Documentation"> <span class="octicon octicon-question octicon-footer"></span> </a> @@ -736,4 +793,5 @@ be auto-numbered as <code>1.4.2</code>.< ZeroClipboard.config({ moviePath: '/style/js/zeroclipboard/ZeroClipboard.swf' }); </script> <script src="/style/js/public.js"></script> + </html>
Modified: brooklyn/site/contributing/inline-children.html URL: http://svn.apache.org/viewvc/brooklyn/site/contributing/inline-children.html?rev=1925014&r1=1925013&r2=1925014&view=diff ============================================================================== --- brooklyn/site/contributing/inline-children.html (original) +++ brooklyn/site/contributing/inline-children.html Fri Apr 11 07:44:54 2025 @@ -1,23 +1,23 @@ <h3 id="inline-children">Inline Children</h3> -<p>In addition to the <code>children</code> property defining lower pages in the site structure, they can also be used to define +<p>In addition to the <code class="language-plaintext highlighter-rouge">children</code> property defining lower pages in the site structure, they can also be used to define inline sections within the current document. Inclusion in this way produces a menu link to an anchor in the current page.</p> <p>Below is an example from <a href="https://github.com/apache/brooklyn-docs/blob/master/guide/ops/persistence/index.md"; target="_blank">/guide/ops/persistence/index.md</a>:</p> -<div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="l-Scalar-Plain">children</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Command Line Options</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">File-based Persistence</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Object Store Persistence</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Rebinding to State</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Writing Persistable Code</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">section</span><span class="p-Indicator">:</span> <span class="nv">Persisted State Backup</span> <span class="p-Indicator">}</span></code></pre></div> - -<p>Inline sections can also be detected from separate, child <code>.md</code> files. Including the tag <code>check_directory_for_children: true</code> -in the YAML front matter of a page causes the site structure plug-in to look through the current directory for any <code>.md</code> files -containing <code>section_type: inline</code> in the YAML front matter.</p> +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">children</span><span class="pi">:</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Command Line Options</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">File-based Persistence</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Object Store Persistence</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Rebinding to State</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Writing Persistable Code</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">section</span><span class="pi">:</span> <span class="nv">Persisted State Backup</span> <span class="pi">}</span></code></pre></figure> + +<p>Inline sections can also be detected from separate, child <code class="language-plaintext highlighter-rouge">.md</code> files. Including the tag <code class="language-plaintext highlighter-rouge">check_directory_for_children: true</code> +in the YAML front matter of a page causes the site structure plug-in to look through the current directory for any <code class="language-plaintext highlighter-rouge">.md</code> files +containing <code class="language-plaintext highlighter-rouge">section_type: inline</code> in the YAML front matter.</p> -<p>The content from these inline sections can then be included in the page content using the liquid tag <code>child_content</code>. This is shown below +<p>The content from these inline sections can then be included in the page content using the liquid tag <code class="language-plaintext highlighter-rouge">child_content</code>. This is shown below in an example from <a href="https://github.com/apache/brooklyn-docs/blob/master/guide/locations/index.md"; target="_blank">/guide/locations/index.md</a>:</p> <pre> Modified: brooklyn/site/contributing/ordering.html URL: http://svn.apache.org/viewvc/brooklyn/site/contributing/ordering.html?rev=1925014&r1=1925013&r2=1925014&view=diff ============================================================================== --- brooklyn/site/contributing/ordering.html (original) +++ brooklyn/site/contributing/ordering.html Fri Apr 11 07:44:54 2025 @@ -1,38 +1,38 @@ <h3 id="child-page-ordering">Child Page Ordering</h3> -<p>Child pages are by default, ordered by their position in the <code>children</code> YAML front matter field. This can be changed using the property -<code>section_position</code> in the child YAML. For children defined in the front matter this is put in the child object of the <code>children</code> array.</p> +<p>Child pages are by default, ordered by their position in the <code class="language-plaintext highlighter-rouge">children</code> YAML front matter field. This can be changed using the property +<code class="language-plaintext highlighter-rouge">section_position</code> in the child YAML. For children defined in the front matter this is put in the child object of the <code class="language-plaintext highlighter-rouge">children</code> array.</p> -<p>For inline children, sourced using <code>check_directory_for_children: true</code>, this <code>section_position</code> property is put in the child fileâs YAML front matter.</p> +<p>For inline children, sourced using <code class="language-plaintext highlighter-rouge">check_directory_for_children: true</code>, this <code class="language-plaintext highlighter-rouge">section_position</code> property is put in the child fileâs YAML front matter.</p> -<p>The format for <code>section_position</code> is that of software versioning, i.e <code>A.B... Z</code> where A, B etc are numbers of decreasing value. Position <code>1.1.0</code> would appear -before version <code>1.0.4</code> for example. This allows an infinite number of sub pages between each <code>section_position</code>.</p> +<p>The format for <code class="language-plaintext highlighter-rouge">section_position</code> is that of software versioning, i.e <code class="language-plaintext highlighter-rouge">A.B... Z</code> where A, B etc are numbers of decreasing value. Position <code class="language-plaintext highlighter-rouge">1.1.0</code> would appear +before version <code class="language-plaintext highlighter-rouge">1.0.4</code> for example. This allows an infinite number of sub pages between each <code class="language-plaintext highlighter-rouge">section_position</code>.</p> <p>Any un-versioned pages are automatically numbered to add a new minor version from the last page if that was numbered or increment the minor -if it was not. If no pages are yet numbered, the numbering is started at <code>1.1</code>. For example, if a numbered page, <code>1.4</code> is followed by a -non-numbered page, the non-numbered page would be auto-numbered as <code>1.4.1</code>. If this page is followed by another non-numbered page it would -be auto-numbered as <code>1.4.2</code>.</p> +if it was not. If no pages are yet numbered, the numbering is started at <code class="language-plaintext highlighter-rouge">1.1</code>. For example, if a numbered page, <code class="language-plaintext highlighter-rouge">1.4</code> is followed by a +non-numbered page, the non-numbered page would be auto-numbered as <code class="language-plaintext highlighter-rouge">1.4.1</code>. If this page is followed by another non-numbered page it would +be auto-numbered as <code class="language-plaintext highlighter-rouge">1.4.2</code>.</p> <p>For example, a set of children pages numbered like this:</p> -<div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="l-Scalar-Plain">children</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/start/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/download.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/concepts/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/blueprints/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/blueprints/java/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/ops/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/index.md</span> <span class="p-Indicator">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">children</span><span class="pi">:</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/start/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/download.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/concepts/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/blueprints/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/blueprints/java/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/ops/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/index.md</span> <span class="pi">}</span></code></pre></figure> <p>Would end up numbered like this:</p> -<div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="l-Scalar-Plain">children</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/ops/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">2.1</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/start/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/download.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2.1</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/concepts/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2.2</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/yaml/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2.3</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/java/index.md</span><span class="p-Indicator">,</span> <span class="nv">section_position</span><span class="p-Indicator">:</span> <span class="nv">3.1.2.4</span> <span class="p-Indicator">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">children</span><span class="pi">:</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/ops/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">2.1</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/start/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/download.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2.1</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/concepts/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2.2</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/yaml/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2.3</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/java/index.md</span><span class="pi">,</span> <span class="nv">section_position</span><span class="pi">:</span> <span class="nv">3.1.2.4</span> <span class="pi">}</span></code></pre></figure> -<p>This ordering affects both the position of the child in the html menu and the order of content included with <code>child_content</code>.</p> +<p>This ordering affects both the position of the child in the html menu and the order of content included with <code class="language-plaintext highlighter-rouge">child_content</code>.</p> Added: brooklyn/site/contributing/pdf-manual.html URL: http://svn.apache.org/viewvc/brooklyn/site/contributing/pdf-manual.html?rev=1925014&view=auto ============================================================================== --- brooklyn/site/contributing/pdf-manual.html (added) +++ brooklyn/site/contributing/pdf-manual.html Fri Apr 11 07:44:54 2025 @@ -0,0 +1,48 @@ +<h2 id="single-page-manual-and-pdf">Single Page Manual and PDF</h2> + +<p>A single page overview of selections of the site are available in <code class="language-plaintext highlighter-rouge">zoneMergeManual</code> and <code class="language-plaintext highlighter-rouge">zoneMergeStarted</code>. These overviews are for the user manual +and getting started guide respectively. The zone merge pages go through the <a href="/contributing/#site-structure">site structure</a>, described above, and compile the files from this into a +single HTML page.</p> + +<p>In order to do this, each page is iterated over in order and itâs rendered content included in the page. The plug-in <code class="language-plaintext highlighter-rouge">regex_filter.rb</code> is used to re-write + <a> links from the structured site into a form which works on a single page. Links are re-written in the following manner:</p> + +<ul> + <li>If the link is from an external domain, leave it as an unaltered link</li> + <li>If the link is an anchor, convert to the anchor scheme used in the single page</li> + <li>If the link target is in the single page, change the link to point at the anchor in the single page</li> + <li>If the link is pointing at somewhere on the brooklyn site which is not included in this single page, point to the website with a specific version, so https://brooklyn.apache.org/v/0.9.0-SNAPSHOT/start/concept-quickstart.html for instance</li> +</ul> + +<p>In addition, all images srcâs are re-written relative to the root directory.</p> + +<p>Pages can be masked from the compilation process by defining a <code class="language-plaintext highlighter-rouge">page_mask</code> in the YAML front matter of the zone merge file, then including this mask as <code class="language-plaintext highlighter-rouge">true</code> in the child page to exclude. +These pages will then not be included in the compiled single page. Note that this will mask both the child page and any children of this masked page. +For example <a href="https://github.com/apache/brooklyn-docs/blob/master/zoneMergeStarted.html"; target="_blank">zoneMergeStarted</a> uses the mask <code class="language-plaintext highlighter-rouge">started-pdf-exclude</code>:</p> + +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">title</span><span class="pi">:</span> <span class="s">Apache Brooklyn Manual</span> +<span class="na">layout</span><span class="pi">:</span> <span class="s">singlePage</span> +<span class="na">page_mask</span><span class="pi">:</span> <span class="s">started-pdf-exclude</span> +<span class="nn">...</span></code></pre></figure> + +<p>Then in latter pages, such as <a href="https://github.com/apache/brooklyn-docs/blob/master/guide/ops/index.md"; target="_blank">/guide/ops/index.md</a> include <code class="language-plaintext highlighter-rouge">started-pdf-exclude: true</code> to +exclude this section from the getting started guide.</p> + +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">title</span><span class="pi">:</span> <span class="s">Operations</span> +<span class="na">started-pdf-exclude</span><span class="pi">:</span> <span class="no">true</span> +<span class="nn">...</span></code></pre></figure> + +<p>This will exclude not only the operations page but all of the operations section.</p> + +<p>Specific content can be also be masked or unmasked at a page component level by specifying CSS show and hide classes:</p> + +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">css_hide_class</span><span class="pi">:</span> <span class="s">usermanual-pdf-exclude</span> +<span class="na">css_show_class</span><span class="pi">:</span> <span class="s">usermanual-pdf-include</span></code></pre></figure> + +<p>If the above YAML is included in the front matter of a zone merge file, the classes <code class="language-plaintext highlighter-rouge">usermanual-pdf-exclude</code> and <code class="language-plaintext highlighter-rouge">usermanual-pdf-include</code> will add or remove a +<code class="language-plaintext highlighter-rouge">display: none</code> to a HTML object. In addition the single page theme files <a href="https://github.com/apache/brooklyn-docs/blob/master/_layouts/singlePage.html"; target="_blank">singlePage.html</a> and +<a href="https://github.com/apache/brooklyn-docs/blob/master/style/css/singlePage.css";>singlePage.css</a> can be used to style only the single merged pages.</p> + +<h3 id="conversion-to-pdf">Conversion to PDF</h3> + +<p>These single merged pages are then converted to PDF using wkhtmltopdf in the build scripts of this site.</p> Modified: brooklyn/site/contributing/site-structure.html URL: http://svn.apache.org/viewvc/brooklyn/site/contributing/site-structure.html?rev=1925014&r1=1925013&r2=1925014&view=diff ============================================================================== --- brooklyn/site/contributing/site-structure.html (original) +++ brooklyn/site/contributing/site-structure.html Fri Apr 11 07:44:54 2025 @@ -1,22 +1,22 @@ <h2 id="site-structure">Site Structure</h2> -<p>The site structure and menus are built by a plug-in in <code>site_structure.rb</code>. This plug-in looks in the <a href="https://jekyllrb.com/docs/frontmatter/"; target="_blank">YAML front matter</a> -for child pages to build the structure, and breadcrumbs to determine the parent pages to display. </p> +<p>The site structure and menus are built by a plug-in in <code class="language-plaintext highlighter-rouge">site_structure.rb</code>. This plug-in looks in the <a href="https://jekyllrb.com/docs/frontmatter/"; target="_blank">YAML front matter</a> +for child pages to build the structure, and breadcrumbs to determine the parent pages to display.</p> -<p>Child pages are a list of objects, stored in the field <code>children</code>. These are defined by string path to a file or a YAML -object with a <code>path</code> to another file, or a <code>link</code> to an external URL. In addition a <code>title</code> can be defined +<p>Child pages are a list of objects, stored in the field <code class="language-plaintext highlighter-rouge">children</code>. These are defined by string path to a file or a YAML +object with a <code class="language-plaintext highlighter-rouge">path</code> to another file, or a <code class="language-plaintext highlighter-rouge">link</code> to an external URL. In addition a <code class="language-plaintext highlighter-rouge">title</code> can be defined for the text content of the HTML menu option. See the example below from <a href="https://github.com/apache/brooklyn-docs/blob/master/guide/index.md"; target="_blank">/guide/index.md</a></p> -<div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="l-Scalar-Plain">breadcrumbs</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="l-Scalar-Plain">/website/documentation/index.md</span> -<span class="p-Indicator">-</span> <span class="l-Scalar-Plain">index.md</span> -<span class="l-Scalar-Plain">children</span><span class="p-Indicator">:</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/start/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/download.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/concepts/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/blueprints/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/java/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/ops/index.md</span> <span class="p-Indicator">}</span> -<span class="p-Indicator">-</span> <span class="p-Indicator">{</span> <span class="nv">path</span><span class="p-Indicator">:</span> <span class="nv">/guide/misc/index.md</span> <span class="p-Indicator">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">breadcrumbs</span><span class="pi">:</span> +<span class="pi">-</span> <span class="s">/website/documentation/index.md</span> +<span class="pi">-</span> <span class="s">index.md</span> +<span class="na">children</span><span class="pi">:</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/start/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/download.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/concepts/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/blueprints/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/java/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/ops/index.md</span> <span class="pi">}</span> +<span class="pi">-</span> <span class="pi">{</span> <span class="nv">path</span><span class="pi">:</span> <span class="nv">/guide/misc/index.md</span> <span class="pi">}</span></code></pre></figure> Modified: brooklyn/site/developers/code-standards.html URL: http://svn.apache.org/viewvc/brooklyn/site/developers/code-standards.html?rev=1925014&r1=1925013&r2=1925014&view=diff ============================================================================== --- brooklyn/site/developers/code-standards.html (original) +++ brooklyn/site/developers/code-standards.html Fri Apr 11 07:44:54 2025 @@ -25,7 +25,7 @@ <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> -<link href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css"; rel="stylesheet" /> +<link href="/style/deps/bootstrap.min.css" rel="stylesheet" /> <link href="/style/deps/octicons/octicons.css" rel="stylesheet" /> <link href="/style/deps/bootstrap-theme.css" rel="stylesheet" /> <link href="/style/deps/font-awesome-4.2.0/css/font-awesome.min.css" rel="stylesheet" /> @@ -33,7 +33,8 @@ <link href="/style/css/code.css" rel="stylesheet" /> <link href="/style/css/website.css" rel="stylesheet" /> -<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js";></script> +<script type="text/javascript" src="/style/deps/jquery.js"></script> + </head> <body class="page"> @@ -55,11 +56,11 @@ <li class="dropdown"> - <a href="/learnmore/index.html" data-toggle="dropdown">learn more <span class="caret"></span></a> + <a href="/learnmore/" data-toggle="dropdown">learn more <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/learnmore/index.html">Learn More</a> + <a href="/learnmore/">Learn More</a> </li> <li class="divider"></li> @@ -72,7 +73,7 @@ <li > - <a href="/learnmore/features/index.html">Features + <a href="/learnmore/features/">Features </a> </li> @@ -86,7 +87,7 @@ <li > - <a href="/learnmore/catalog/index.html">Browse Catalog + <a href="/learnmore/catalog/">Browse Catalog </a> </li> @@ -98,11 +99,11 @@ <li class="dropdown"> - <a href="/v/latest/start/index.html" data-toggle="dropdown">get started <span class="caret"></span></a> + <a href="/v/latest/start/" data-toggle="dropdown">get started <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/v/latest/start/index.html">Get Started</a> + <a href="/v/latest/start/">Get Started</a> </li> <li class="divider"></li> @@ -148,17 +149,17 @@ <li class="dropdown"> - <a href="/documentation/index.html" data-toggle="dropdown">documentation <span class="caret"></span></a> + <a href="/documentation/" data-toggle="dropdown">documentation <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/documentation/index.html">Documentation</a> + <a href="/documentation/">Documentation</a> </li> <li class="divider"></li> <li class="section"> - <a href="/v/latest/index.html">User Guide + <a href="/v/latest/">User Guide </a> </li> <li class="divider"></li> @@ -172,21 +173,21 @@ <li > - <a href="/v/latest/locations/index.html">Deploying Blueprints + <a href="/v/latest/locations/">Deploying Blueprints </a> </li> <li class="section"> - <a href="/v/latest/ops/index.html">Reference Guide + <a href="/v/latest/ops/">Reference Guide </a> </li> <li class="divider"></li> <li > - <a href="/v/latest/dev/index.html">Developer Guide + <a href="/v/latest/dev/">Developer Guide </a> </li> @@ -212,11 +213,11 @@ <li class="dropdown"> - <a href="/community/index.html" data-toggle="dropdown">community <span class="caret"></span></a> + <a href="/community/" data-toggle="dropdown">community <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/community/index.html">Community</a> + <a href="/community/">Community</a> </li> <li class="divider"></li> @@ -236,7 +237,7 @@ <li > - <a href="/community/security/index.html">Security Advisories + <a href="/community/security/">Security Advisories </a> </li> @@ -257,8 +258,8 @@ <li > - <a href="/community/gsoc.html">Google Summer of Code - </a> + <a href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy Policy + <span class="octicon octicon-link-external"></span></a> </li> @@ -269,17 +270,17 @@ <li class="dropdown active"> - <a href="/developers/index.html" data-toggle="dropdown">developers <span class="caret"></span></a> + <a href="/developers/" data-toggle="dropdown">developers <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li> - <a href="/developers/index.html">Developers</a> + <a href="/developers/">Developers</a> </li> <li class="divider"></li> <li > - <a href="/developers/code/index.html">Get the Code + <a href="/developers/code/">Get the Code </a> </li> @@ -293,14 +294,14 @@ <li > - <a href="/v/latest/dev/index.html">Developer Guide + <a href="/v/latest/dev/">Developer Guide </a> </li> <li > - <a href="/developers/committers/index.html">Committer Guide + <a href="/developers/committers/">Committer Guide </a> </li> @@ -340,7 +341,7 @@ <li class="dropdown"> - <a href="/download/index.html" class="btn btn-default navbar-btn">download</a> + <a href="/download/" class="btn btn-default navbar-btn">download</a> </li> @@ -379,7 +380,7 @@ reason (this makes history and merges mu <h4 class=""> - <a href="/developers/index.html" class="list-group-item breadcrumb breadcrumb0"> + <a href="/developers/" class="list-group-item breadcrumb breadcrumb0"> Developers </a></h4> @@ -387,7 +388,7 @@ reason (this makes history and merges mu - <a href="/developers/code/index.html" class="list-group-item">Get the Code + <a href="/developers/code/" class="list-group-item">Get the Code </a> @@ -401,14 +402,14 @@ reason (this makes history and merges mu - <a href="/v/latest/dev/index.html" class="list-group-item">Developer Guide + <a href="/v/latest/dev/" class="list-group-item">Developer Guide </a> - <a href="/developers/committers/index.html" class="list-group-item">Committer Guide + <a href="/developers/committers/" class="list-group-item">Committer Guide </a> @@ -631,8 +632,8 @@ reason (this makes history and merges mu </div> <div class="col-md-3 text-right"> <p> - <a class="btn btn-sm btn-default" href="https://github.com/apache/brooklyn-docs/edit/website/developers/code-standards.md";>Edit This Page</a> - <a href="https://brooklyn.apache.org/community/how-to-contribute-docs.html"; + <a class="btn btn-sm btn-default" href="https://github.com/apache/brooklyn-docs/edit/master/website/developers/code-standards.md";>Edit This Page</a> + <a href="/community/how-to-contribute-docs.html" data-toggle="tooltip" data-placement="top" title="" data-delay="400" data-original-title="How to Edit Documentation"> <span class="octicon octicon-question octicon-footer"></span> </a> @@ -671,4 +672,5 @@ reason (this makes history and merges mu ZeroClipboard.config({ moviePath: '/style/js/zeroclipboard/ZeroClipboard.swf' }); </script> <script src="/style/js/public.js"></script> + </html>
