You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by tb...@apache.org on 2018/02/16 10:26:54 UTC

[15/25] brooklyn-docs git commit: Break the join with the guide; just use links

Break the join with the guide; just use links

At this point, the generated HTML for website-root is exactly the same
as before the split, with the exception of the site map and one or two
very small differences.


Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/cebbd3aa
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/cebbd3aa
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/cebbd3aa

Branch: refs/heads/website
Commit: cebbd3aa3fb870f1b63fffb0ca3b12ee07b48177
Parents: 58bb3aa
Author: Richard Downer <ri...@apache.org>
Authored: Thu Oct 12 10:33:05 2017 +0100
Committer: Richard Downer <ri...@apache.org>
Committed: Tue Oct 17 13:26:06 2017 +0100

----------------------------------------------------------------------
 _includes/footer.html          |  2 +-
 _plugins/site_structure.rb     |  2 +-
 website/developers/index.md    |  4 +-
 website/documentation/index.md | 17 +++++++--
 website/download/index.md      |  4 +-
 website/index.md               | 73 +++++++++++++++++++++++++++++++------
 6 files changed, 81 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cebbd3aa/_includes/footer.html
----------------------------------------------------------------------
diff --git a/_includes/footer.html b/_includes/footer.html
index d015acb..fb4ba97 100644
--- a/_includes/footer.html
+++ b/_includes/footer.html
@@ -5,7 +5,7 @@
         </div>
         <div class="col-md-3 text-right">
             <p>
-                <a class="btn btn-sm btn-default" href="https://github.com/apache/brooklyn-docs/edit/master/{{ page.path }}">Edit This Page</a>
+                <a class="btn btn-sm btn-default" href="https://github.com/apache/brooklyn-docs/edit/master/website/{{ page.path }}">Edit This Page</a>
                 <a href="{{ site.url_root }}{{ site.path.website }}/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>

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cebbd3aa/_plugins/site_structure.rb
----------------------------------------------------------------------
diff --git a/_plugins/site_structure.rb b/_plugins/site_structure.rb
index 5f2d42b..e95ea6f 100644
--- a/_plugins/site_structure.rb
+++ b/_plugins/site_structure.rb
@@ -278,7 +278,7 @@ module SiteStructure
       elsif (item['link'])
         puts "setting up #{item} as link" if @@verbose
         link = render_liquid(site, parent, item['link'])
-        data = { 'link' => link, 'url' => link, 'external' => true }
+        data = { 'link' => link, 'url' => link, 'external' => item['not_external'] ? false : true }
         data['title'] = item['title'] if item['title']
         breadcrumb_pages << data
         breadcrumb_paths << data['link']

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cebbd3aa/website/developers/index.md
----------------------------------------------------------------------
diff --git a/website/developers/index.md b/website/developers/index.md
index 4f0e605..df19f20 100644
--- a/website/developers/index.md
+++ b/website/developers/index.md
@@ -5,7 +5,9 @@ started-pdf-exclude: true
 children:
 - code/
 - how-to-contribute.md
-- /guide/dev/
+- link: /v/latest/dev/index.html
+  title_in_menu: "Developer Guide"
+  not_external: true
 - committers/
 - code-standards.md
 - links.md

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cebbd3aa/website/documentation/index.md
----------------------------------------------------------------------
diff --git a/website/documentation/index.md b/website/documentation/index.md
index 80f9555..a6979bd 100644
--- a/website/documentation/index.md
+++ b/website/documentation/index.md
@@ -3,10 +3,19 @@ layout: website-normal
 title: Documentation
 started-pdf-exclude: true
 children:
-- /guide/
-- /guide/dev/
-- ../meta/versions.md
-- other-docs.md
+  - link: /v/latest/index.html
+    title_in_menu: "User Guide"
+    not_external: true
+
+  - link: /v/latest/dev/index.html
+    title_in_menu: Developer Guide
+    not_external: true
+
+  - path: ../meta/versions.md
+    title_in_menu: Versions
+
+  - path: other-docs.md
+    title_in_menu: Other Resources
 ---
 
 {% comment %}

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cebbd3aa/website/download/index.md
----------------------------------------------------------------------
diff --git a/website/download/index.md b/website/download/index.md
index e6ed6dd..b74f002 100644
--- a/website/download/index.md
+++ b/website/download/index.md
@@ -4,9 +4,9 @@ title: Download
 started-pdf-exclude: true
 usermanual-pdf-exclude: true
 children:
-- { path: /guide/misc/download.md, title: Details }
+- { link: /v/latest/misc/download.html, title: Details, not_external: true }
 - { path: verify.md, title: Verify }
-- /guide/misc/release-notes.md
+- { link: /v/latest/misc/release-notes.html, title: Release Notes, not_external: true }
 - ../meta/versions.md
 ---
 

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cebbd3aa/website/index.md
----------------------------------------------------------------------
diff --git a/website/index.md b/website/index.md
index 2bc26c4..e3f8099 100644
--- a/website/index.md
+++ b/website/index.md
@@ -3,22 +3,71 @@ layout: website-landing
 title: Home
 children:
 - learnmore/
-- { path: /guide/start/index.md, title_in_menu: Get Started, href_path: /guide/start/index.md}
+
+- link: /v/latest/start/index.html
+  title_in_menu: Get Started
+  href_link: /v/latest/start/index.md
+  menu:
+  - link: /v/latest/start/running.html
+    title_in_menu: "Running Apache Brooklyn"
+    not_external: true
+
+  - link: /v/latest/start/blueprints.html
+    title_in_menu: "Deploying Blueprints"
+    not_external: true
+
+  - link: /v/latest/start/managing.html
+    title_in_menu: "Monitoring and Managing Applications"
+    not_external: true
+
+  - link: /v/latest/start/policies.html
+    title_in_menu: "Policies"
+    not_external: true
+
+  - link: /v/latest/start/concept-quickstart.html
+    title_in_menu: "Brooklyn Concepts Quickstart"
+    not_external: true
+
 - path: documentation/
   menu:
-  - { path: /guide/index.md, title_in_menu: "User Guide", 
-      menu_customization: { dropdown_section_header: true } }
-  - { path: /guide/blueprints/index.md, title_in_menu: Writing Blueprints, href_path: /guide/blueprints/creating-yaml.md }
-  - { path: /guide/locations/index.md, title_in_menu: Deploying Blueprints }
-  - { path: /guide/ops/index.md, title_in_menu: Reference Guide,
-      menu_customization: { dropdown_section_header: true } }
-  - { path: /guide/dev/index.md, title_in_menu: Developer Guide }
-  - { path: meta/versions.md, title_in_menu: Versions,
-      menu_customization: { dropdown_new_section: true } }
-  - { path: documentation/other-docs.md, title_in_menu: Other Resources }
+
+  - link: /v/latest/index.html
+    title_in_menu: "User Guide"
+    menu_customization: { dropdown_section_header: true }
+    not_external: true
+
+  - link: /v/latest/blueprints/creating-yaml.html
+    title_in_menu: Writing Blueprints
+    not_external: true
+
+  - link: /v/latest/locations/index.html
+    title_in_menu: Deploying Blueprints
+    not_external: true
+
+  - link: /v/latest/ops/index.html
+    title_in_menu: Reference Guide
+    menu_customization: { dropdown_section_header: true }
+    not_external: true
+
+  - link: /v/latest/dev/index.html
+    title_in_menu: Developer Guide
+    not_external: true
+
+  - path: meta/versions.md
+    title_in_menu: Versions
+    menu_customization: { dropdown_new_section: true }
+
+  - path: documentation/other-docs.md
+    title_in_menu: Other Resources
+
 - community/
+
 - developers/
-- { path: download/, menu: null, type: button, menu_customization: {type: button} }
+
+- path: download/
+  menu: null
+  type: button
+  menu_customization: {type: button}
 ---
 
 <section class="text-center hero" markdown="1">