From d80395fcfdd58d48e197cbf2c5be259a39c18c09 Mon Sep 17 00:00:00 2001 From: Duncan Godwin Date: Wed, 6 Jul 2016 17:51:36 +0100 Subject: [PATCH 1/3] Fixed links --- guide/java/entities.md | 2 +- guide/misc/javadoc/index.md | 2 +- guide/ops/production-installation.md | 12 ++++++------ guide/yaml/ansible/index.md | 2 +- guide/yaml/blueprinting-tips.md | 2 +- guide/yaml/configuring-vms.md | 2 +- guide/yaml/creating-yaml.md | 6 +++--- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/guide/java/entities.md b/guide/java/entities.md index b83bfc96..1e2623db 100644 --- a/guide/java/entities.md +++ b/guide/java/entities.md @@ -113,7 +113,7 @@ wiring for the sensors, and the effector implementations. In simple cases it may to capture the behaviour of the effectors in a simple methods. For example deploying a WAR to a cluster can be done as follows: -*This section is not complete. Feel free to [fork]({{site.path.guide}}/dev/code) the docs and lend a hand.* +*This section is not complete. Feel free to [fork](https://github.com/apache/brooklyn-docs) the docs and lend a hand.* diff --git a/guide/ops/production-installation.md b/guide/ops/production-installation.md index b0110d5f..12f25e8b 100644 --- a/guide/ops/production-installation.md +++ b/guide/ops/production-installation.md @@ -15,19 +15,19 @@ To install Apache Brooklyn on a production server: This guide covers the basics. You may also wish to configure: -* [Logging](logging.md) +* [Logging](logging.html) * [Persistence](persistence/) -* [High availability](high-availability.md) +* [High availability](high-availability/) ### Set up the Prerequisites -Check that the server meets the [requirements](requirements.md). +Check that the server meets the [requirements](requirements.html). Then configure the server as follows: * install Java JRE or JDK (version 7 or later) -* install an [SSH key]({{ site.path.guide }}/ops/locations/ssh-keys.html), if not available -* enable [passwordless ssh login]({{ site.path.guide }}/ops/locations/ssh-keys.html) +* install an [SSH key]({{ site.path.guide }}/ops/locations/index.html#ssh-keys), if not available +* enable [passwordless ssh login]({{ site.path.guide }}/ops/locations/index.html#ssh-keys) * create a `~/.brooklyn` directory on the host with `$ mkdir ~/.brooklyn` * check your `iptables` or other firewall service, making sure that incoming connections on port 8443 is not blocked * check that the [linux kernel entropy]({{ site.path.website }}/documentation/increase-entropy.html) is sufficient @@ -66,7 +66,7 @@ Let's setup some paths for easy commands. ### Configuring brooklyn.properties -Set up `brooklyn.properties` as described [here](brooklyn_properties.md): +Set up `brooklyn.properties` as described [here](brooklyn_properties.html): * Configure the users who should have access * Turn on HTTPS diff --git a/guide/yaml/ansible/index.md b/guide/yaml/ansible/index.md index 1cda04ee..3f2999c6 100644 --- a/guide/yaml/ansible/index.md +++ b/guide/yaml/ansible/index.md @@ -7,7 +7,7 @@ children: --- This guide describes how Brooklyn entities can be created using the Ansible infrastructure management tool - ([ansiblestack.com](ansiblestack.com)). + ([ansible.com](ansible.com)). At present Brooklyn provides basic support for Ansible, operating in a 'masterless' mode. Comments on this support and suggestions for further development are welcome. diff --git a/guide/yaml/blueprinting-tips.md b/guide/yaml/blueprinting-tips.md index 6f027463..c9181742 100644 --- a/guide/yaml/blueprinting-tips.md +++ b/guide/yaml/blueprinting-tips.md @@ -48,7 +48,7 @@ and to use these as the target for a BYON location. Docker containers provide a convenient way to test blueprints (and also to run blueprints in production!). -The [Clocker project](www.clocker.io) allows the simple setup of Docker Engine(s), and for Docker +The [Clocker project](http://www.clocker.io) allows the simple setup of Docker Engine(s), and for Docker containers to be used instead of VMs. For testing, this allows each run to start from a fresh container (i.e. no install artifacts from previous runs), while taking advantage of the speed of starting containers. diff --git a/guide/yaml/configuring-vms.md b/guide/yaml/configuring-vms.md index 97fb9d00..7ae341fd 100644 --- a/guide/yaml/configuring-vms.md +++ b/guide/yaml/configuring-vms.md @@ -28,4 +28,4 @@ including: * `machineCreateAttempts` (for dodgy clouds, and they nearly all fail occasionally!) * and things like `imageId` and `userMetadata` and disk and networking options (e.g. `autoAssignFloatingIp` for private clouds) -For more information, see [Operations: Locations](../ops/locations/). +For more information, see [Operations: Locations]({{ site.path.guide }}/ops/locations/index.html). diff --git a/guide/yaml/creating-yaml.md b/guide/yaml/creating-yaml.md index 8bc22c46..603b0cde 100644 --- a/guide/yaml/creating-yaml.md +++ b/guide/yaml/creating-yaml.md @@ -25,7 +25,7 @@ Here's a very simple YAML blueprint plan, to explain the structure: * The `name` is just for the benefit of us humans. * The `location` specifies where this should be deployed. - If you've [set up passwordless localhost SSH access](../ops/locations/#localhost) + If you've [set up passwordless localhost SSH access]({{ site.path.guide }}/ops/locations/#localhost) you can use `localhost` as above, but if not, just wait ten seconds for the next example. * The `services` block takes a list of the typed services we want to deploy. @@ -37,7 +37,7 @@ then in the "Create Application" dialog at the web console (usually [http://127.0.0.1:8081/](http://127.0.0.1:8081/), paste the copied YAML into the "Yaml" tab of the dialog and press "Finish". There are several other ways to deploy, including `curl` and via the command-line, and you can configure users, https, persistence, and more, -as described [in the ops guide](../ops/). +as described [in the ops guide]({{ site.path.guide }}/ops/). [![Web Console](web-console-yaml-700.png "YAML via Web Console")](web-console-yaml.png) @@ -57,7 +57,7 @@ Topics to explore next on the topic of YAML blueprints are: {% include list-children.html %} Plenty of examples of blueprints exist in the Brooklyn codebase, -so another starting point is to [`git clone`]({{ site.path.guide }}/developers/code/index.html) it +so another starting point is to [`git clone`]({{ site.path.website }}/developers/code/index.html) it and search for `*.yaml` files therein. Brooklyn lived as a Java framework for many years before we felt confident From e2fd79b42c502b13b0a68eadd4229990f4d0a3e9 Mon Sep 17 00:00:00 2001 From: Duncan Godwin Date: Wed, 6 Jul 2016 18:11:25 +0100 Subject: [PATCH 2/3] More links fixed --- guide/ops/brooklyn_properties.md | 2 +- guide/yaml/ansible/index.md | 2 +- guide/yaml/salt/index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/guide/ops/brooklyn_properties.md b/guide/ops/brooklyn_properties.md index 28052978..8d513238 100644 --- a/guide/ops/brooklyn_properties.md +++ b/guide/ops/brooklyn_properties.md @@ -15,7 +15,7 @@ children: The file `~/.brooklyn/brooklyn.properties` is read when Brooklyn starts to load server configuration values. A different properties file can be specified either additionally or instead -through [CLI options](launch.html#configuration-files). +through [CLI options](server-cli-reference.html). A template [brooklyn.properties]({{brooklyn_properties_url_path}}) file is available, with abundant comments. diff --git a/guide/yaml/ansible/index.md b/guide/yaml/ansible/index.md index 3f2999c6..a2376d1d 100644 --- a/guide/yaml/ansible/index.md +++ b/guide/yaml/ansible/index.md @@ -7,7 +7,7 @@ children: --- This guide describes how Brooklyn entities can be created using the Ansible infrastructure management tool - ([ansible.com](ansible.com)). + ([ansible.com](http://ansible.com)). At present Brooklyn provides basic support for Ansible, operating in a 'masterless' mode. Comments on this support and suggestions for further development are welcome. diff --git a/guide/yaml/salt/index.md b/guide/yaml/salt/index.md index 2992b529..265e07fb 100644 --- a/guide/yaml/salt/index.md +++ b/guide/yaml/salt/index.md @@ -7,7 +7,7 @@ children: --- This guide describes how Brooklyn entities can be created using the Salt infrastructure management tool - ([saltstack.com](saltstack.com)). + ([saltstack.com](https://saltstack.com/)). At present Brooklyn provides basic support for Salt, operating in a 'masterless' mode. Comments on this support and suggestions for further development are welcome. From 2c6629e719876ad14d6feb51543db1fd4b07e80a Mon Sep 17 00:00:00 2001 From: Duncan Godwin Date: Thu, 7 Jul 2016 10:40:02 +0100 Subject: [PATCH 3/3] Updated src repo link --- _includes/java_link.html | 4 ++-- _plugins/brooklyn_metadata.rb | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_includes/java_link.html b/_includes/java_link.html index 94118779..4461f372 100644 --- a/_includes/java_link.html +++ b/_includes/java_link.html @@ -8,8 +8,8 @@ {% endcomment %}{% if include.project_subpath %}{{ include.class_name }} - (javadoc, - src){% comment %} + ({% comment %}javadoc, + {% endcomment %}src){% comment %} {% endcomment %}{% else %} {{ include.class_name }} {% endif %}{% comment %} diff --git a/_plugins/brooklyn_metadata.rb b/_plugins/brooklyn_metadata.rb index 7bbdc6fd..c210c3d5 100644 --- a/_plugins/brooklyn_metadata.rb +++ b/_plugins/brooklyn_metadata.rb @@ -44,7 +44,7 @@ def generate(site) } end - url_set["git"] = "https://github.com/apache/brooklyn/tree/#{ git_branch }" + url_set["git"] = "https://github.com/apache/brooklyn-server/tree/#{ git_branch }" site.config['brooklyn'] = { "version" => BrooklynMetadata::BROOKLYN_VERSION,