Remove references to book.path.guide as they can be resolved relatively
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/9647d82e Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/9647d82e Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/9647d82e Branch: refs/heads/master Commit: 9647d82e917ca3ee93bc507d039af338510fb55d Parents: 8203853 Author: Thomas Bouron <[email protected]> Authored: Thu Oct 12 11:05:06 2017 +0100 Committer: Thomas Bouron <[email protected]> Committed: Mon Oct 16 14:56:04 2017 +0100 ---------------------------------------------------------------------- book.json | 4 ++-- guide/blueprints/blueprinting-tips.md | 6 +++--- guide/blueprints/creating-yaml.md | 4 ++-- guide/blueprints/entity-configuration.md | 2 +- guide/blueprints/java/archetype.md | 2 +- guide/blueprints/java/bundle-dependencies.md | 2 +- guide/blueprints/java/defining-and-deploying.md | 2 +- guide/blueprints/setting-locations.md | 4 ++-- guide/blueprints/test/usage-examples.md | 2 +- guide/blueprints/winrm/index.md | 2 +- guide/blueprints/yaml-reference.md | 2 +- guide/locations/_clouds.md | 2 +- guide/locations/index.md | 2 +- guide/misc/download.md | 2 +- guide/ops/troubleshooting/slow-unresponsive.md | 2 +- guide/start/blueprints.md | 6 +++--- guide/start/concept-quickstart.md | 2 +- guide/start/running.md | 2 +- 18 files changed, 25 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/book.json ---------------------------------------------------------------------- diff --git a/book.json b/book.json index b89b723..3ec59a5 100644 --- a/book.json +++ b/book.json @@ -95,11 +95,11 @@ "brooklyn_version": "1.0.0-SNAPSHOT", "brooklyn_version_stable": "0.12.0", "url": { - "brooklyn_website": "https://brooklyn.apache.org"; + "brooklyn_website": "https://brooklyn.apache.org";, + "brooklyn_javadoc": "https://brooklyn.apache.org"; }, "url_root": "http://0.0.0.0:4000";, "path": { - "guide": "/guide", "website": "/website", "v": "/v" } http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/blueprinting-tips.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/blueprinting-tips.md b/guide/blueprints/blueprinting-tips.md index 9d2a023..34cef6d 100644 --- a/guide/blueprints/blueprinting-tips.md +++ b/guide/blueprints/blueprinting-tips.md @@ -38,7 +38,7 @@ Options for speeding up provisioning include those below. #### Deploying to Bring Your Own Nodes (BYON) -A [BYON location]({{ book.path.guide }}/locations/#byon) can be defined, which avoids the time +A [BYON location](../locations/index.md#byon) can be defined, which avoids the time required to provision VMs. This is fast, but has the downside that artifacts installed during a previous run can interfere with subsequent runs. @@ -114,7 +114,7 @@ real thing. ## Writing Entity Tests -Use the [test framework]({{ book.path.guide }}/blueprints/test/) to write test cases. This will make +Use the [test framework](test/index.md) to write test cases. This will make automated (regression) testing easier, and will allow others to easily confirm that the entity works in their environment. @@ -181,4 +181,4 @@ below may also be of help: ALWAYS keep logs when there is an error. -See the [Troubleshooting]({{ book.path.guide }}/ops/troubleshooting/) guide for more information. +See the [Troubleshooting](../ops/troubleshooting/index.md) guide for more information. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/creating-yaml.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/creating-yaml.md b/guide/blueprints/creating-yaml.md index 5058e76..97907b8 100644 --- a/guide/blueprints/creating-yaml.md +++ b/guide/blueprints/creating-yaml.md @@ -24,7 +24,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]({{ book.path.guide }}/locations/#localhost) + If you've [set up passwordless localhost SSH access](../locations/index.md#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. @@ -36,7 +36,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]({{ book.path.guide }}/ops/). +as described [in the ops guide](../ops/index.md). [](web-console-yaml.png) http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/entity-configuration.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/entity-configuration.md b/guide/blueprints/entity-configuration.md index 483fefa..336a7e9 100644 --- a/guide/blueprints/entity-configuration.md +++ b/guide/blueprints/entity-configuration.md @@ -77,7 +77,7 @@ services: - type: entity-config-example ``` -For details of how to write and add catalog items, see [Catalog]({{ book.path.guide }}/blueprints/catalog/). +For details of how to write and add catalog items, see [Catalog](catalog/index.md). #### Config Key Constraints http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/java/archetype.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/archetype.md b/guide/blueprints/java/archetype.md index f2b0329..8dab377 100644 --- a/guide/blueprints/java/archetype.md +++ b/guide/blueprints/java/archetype.md @@ -60,7 +60,7 @@ $ mvn clean install #### Adding to the Catalog The build will produce an OSGi bundle in `target/autobrick-0.1.0-SNAPSHOT.jar`, suitable for -use in the [Brooklyn catalog]({{ book.path.guide }}/blueprints/catalog/) (using `brooklyn.libraries`). +use in the [Brooklyn catalog](../catalog/index.md) (using `brooklyn.libraries`). To use this in your Brooklyn catalog you will first have to copy the target jar to a suitable location. For developing/testing purposes storing on the local filesystem is fine. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/java/bundle-dependencies.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/bundle-dependencies.md b/guide/blueprints/java/bundle-dependencies.md index 5c2b6d7..c25794b 100644 --- a/guide/blueprints/java/bundle-dependencies.md +++ b/guide/blueprints/java/bundle-dependencies.md @@ -29,7 +29,7 @@ is a convenient way of building OSGi bundles. #### OSGi Bundles Declared in Catalog Items -Within a [catalog item]({{ book.path.guide}}/blueprints/catalog/), a list of URLs can be supplied under +Within a [catalog item](../catalog/index.md), a list of URLs can be supplied under `brooklyn.libraries`. Each URL should point to an OSGi bundle. This list should include the OSGi bundle that has the Java code for your blueprint, and also the OSGi bundles that it depends on (including all transitive dependencies). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/java/defining-and-deploying.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/defining-and-deploying.md b/guide/blueprints/java/defining-and-deploying.md index 786e535..3cc75d4 100644 --- a/guide/blueprints/java/defining-and-deploying.md +++ b/guide/blueprints/java/defining-and-deploying.md @@ -15,7 +15,7 @@ with an effector to create new gists. ## Project Setup Follow the instructions to create a new Java project using the [archetype](archetype.md), and -import it into your [favorite IDE]({{ book.path.guide }}/dev/env/ide/). This example assumes you +import it into your [favorite IDE](../../dev/env/ide/index.md). This example assumes you used the groupId `com.acme` and artifact id `autobrick`. First ensure you can build this project at the command line, using `mvn clean install`. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/setting-locations.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/setting-locations.md b/guide/blueprints/setting-locations.md index 6d5bd79..7ba6253 100644 --- a/guide/blueprints/setting-locations.md +++ b/guide/blueprints/setting-locations.md @@ -8,7 +8,7 @@ categories: [use, guide, defining-applications] Brooklyn supports a very wide range of target locations. With deep integration to [Apache jclouds](https://jclouds.apache.org), most well-known clouds -and cloud platforms are supported. See the [Locations guide]({{ book.path.guide }}/locations/) +and cloud platforms are supported. See the [Locations guide](../locations/index.md) for details and more examples. ### Cloud Example @@ -103,7 +103,7 @@ The examples above have given all the location details within the application bl It is also possible (and indeed preferred) to add the location definitions to the catalog so that they can be referenced by name in any blueprint. -For more information see the [Operations: Catalog]({{ book.path.guide }}/blueprints/catalog/) section of +For more information see the [Operations: Catalog](catalog/index.md) section of the User Guide. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/test/usage-examples.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/test/usage-examples.md b/guide/blueprints/test/usage-examples.md index 5f47dd1..9427c3d 100644 --- a/guide/blueprints/test/usage-examples.md +++ b/guide/blueprints/test/usage-examples.md @@ -44,6 +44,6 @@ This `TestEffector` example demonstrates the use of the `TestCase` and `TestSens ### Full Example A sample blueprint containing all the tests described above is available [here](./example_yaml/testcases/getting-started-test-example.yaml). -This blueprint will deploy the [Getting Started]({{ book.path.guide }}/start/blueprints.html#launching-from-a-blueprint) application and run all of the test entities, which if successful should appear in the web console as follows. +This blueprint will deploy the [Getting Started](../../start/blueprints.md#launching-from-a-blueprint) application and run all of the test entities, which if successful should appear in the web console as follows. [](images/getting-started-blueprint-test-large.png) http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/winrm/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/winrm/index.md b/guide/blueprints/winrm/index.md index 7c8b395..61989ca 100644 --- a/guide/blueprints/winrm/index.md +++ b/guide/blueprints/winrm/index.md @@ -364,7 +364,7 @@ on the Microsoft TechNet site. Troubleshooting --------------- -Much of the [operations troubleshooting guide]({{ book.path.guide }}/ops/troubleshooting/) is applicable for Windows blueprints. +Much of the [operations troubleshooting guide](../../ops/troubleshooting/index.md) is applicable for Windows blueprints. ### User metadata service requirement http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/blueprints/yaml-reference.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/yaml-reference.md b/guide/blueprints/yaml-reference.md index f4a89f9..2767f03 100644 --- a/guide/blueprints/yaml-reference.md +++ b/guide/blueprints/yaml-reference.md @@ -21,7 +21,7 @@ defining types: * `com.acme.brooklyn.package.JavaEntityClass` * `java:com.acme.brooklyn.package.JavaEntityClass` -* `java-entity-class` (where this has been added to the [catalog]({{ book.path.guide }}/blueprints/catalog/)) +* `java-entity-class` (where this has been added to the [catalog](catalog/index.md)) A reference of some of the common service `type` instances used is included in a section below. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/locations/_clouds.md ---------------------------------------------------------------------- diff --git a/guide/locations/_clouds.md b/guide/locations/_clouds.md index d5f49be..183c0c4 100644 --- a/guide/locations/_clouds.md +++ b/guide/locations/_clouds.md @@ -297,7 +297,7 @@ Clouds vary in the format of the identity, credential, endpoint, and region. Some also have their own idiosyncracies. More details for configuring some common clouds is included below. You may also find these sources helpful: -* The **[template brooklyn.properties]({{ book.path.guide }}/start/brooklyn.properties)** file +* The **[template brooklyn.properties](../start/brooklyn.properties)** file in the Getting Started guide contains numerous examples of configuring specific clouds, including the format of credentials and options for sometimes-fiddly private clouds. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/locations/index.md ---------------------------------------------------------------------- diff --git a/guide/locations/index.md b/guide/locations/index.md index ec460fd..1faee7a 100644 --- a/guide/locations/index.md +++ b/guide/locations/index.md @@ -27,7 +27,7 @@ could cause subsequent errors if they do not hold. These relate to the machine's configuration, rather than additional networking or security that a given Cloud might offer. -Also see the [Troubleshooting]({{ book.path.guide }}/ops/troubleshooting/) docs. +Also see the [Troubleshooting](../ops/troubleshooting/index.md) docs. ## Remote Access http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/misc/download.md ---------------------------------------------------------------------- diff --git a/guide/misc/download.md b/guide/misc/download.md index 70acb0c..3ff7e1c 100644 --- a/guide/misc/download.md +++ b/guide/misc/download.md @@ -153,4 +153,4 @@ with this version in branch [{{ book.brooklyn.git_branch }}]({{ book.brooklyn.ur These locations have a `README.md` in the root which explains how to get the code including submodules. -Useful information on working with the source is [here]({{ book.path.guide }}/dev/code). +Useful information on working with the source is [here](../dev/code). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/ops/troubleshooting/slow-unresponsive.md ---------------------------------------------------------------------- diff --git a/guide/ops/troubleshooting/slow-unresponsive.md b/guide/ops/troubleshooting/slow-unresponsive.md index 8b68d64..a8bb390 100644 --- a/guide/ops/troubleshooting/slow-unresponsive.md +++ b/guide/ops/troubleshooting/slow-unresponsive.md @@ -159,7 +159,7 @@ If the Brooklyn Server was originally run to allow a remote debugger to connect discouraged in production!), then this provides a convenient way to investigate why Brooklyn is being slow or unresponsive. See the Debugging Tips in the tip [Debugging Remote Brooklyn](../../dev/tips/debugging-remote-brooklyn.md) -and the [IDE docs]({{ book.path.guide }}/dev/env/ide/) for more information. +and the [IDE docs](../../dev/env/ide/index.md) for more information. ## Log Files http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/start/blueprints.md ---------------------------------------------------------------------- diff --git a/guide/start/blueprints.md b/guide/start/blueprints.md index 1ebd129..2a7c1a4 100644 --- a/guide/start/blueprints.md +++ b/guide/start/blueprints.md @@ -63,7 +63,7 @@ location: {% sample lang="clouds" -%} ### A cloud location -Apache Brooklyn uses [Apcahe jclouds](http://jclouds.apache.org/) to support a range of cloud locations. More information on the range of providers and configurations is available [here]({{ book.path.guide }}/locations/#clouds). +Apache Brooklyn uses [Apcahe jclouds](http://jclouds.apache.org/) to support a range of cloud locations. More information on the range of providers and configurations is available [here](../locations/index.md#clouds). As an example, here is a configuration for [Amazon Web Services (AWS)](http://www.aws.amazon.com). Swap the identity and credential with your AWS account details, then replace the location in your "myapp.yaml" with this. @@ -77,7 +77,7 @@ location: {% sample lang="byon" -%} ### "Bring your own nodes" location -The Bring Your Own Nodes (BYON) configuration allows Apache Brooklyn to make use of already available servers. These can be specified by a list of IP addresses with a user and password as shown below. More information including the full range of configuration options is available [here]({{ book.path.guide }}/locations/#byon). +The Bring Your Own Nodes (BYON) configuration allows Apache Brooklyn to make use of already available servers. These can be specified by a list of IP addresses with a user and password as shown below. More information including the full range of configuration options is available [here](../locations/index.md#byon). Replace the hosts, user and password in the example below with your own server details, then replace the location in your "myapp.yaml" with this. @@ -95,7 +95,7 @@ location: {% endmethod %} -**Note**: For instructions on setting up a variety of locations or storing credentials/locations in a file on disk rather than in the blueprint, see __[Locations]({{ book.path.guide }}/locations)__ in the Operations section of the User Guide. +**Note**: For instructions on setting up a variety of locations or storing credentials/locations in a file on disk rather than in the blueprint, see __[Locations](../locations/index.md)__ in the Operations section of the User Guide. ## Deploying the Application http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/start/concept-quickstart.md ---------------------------------------------------------------------- diff --git a/guide/start/concept-quickstart.md b/guide/start/concept-quickstart.md index 3411a46..5340d15 100644 --- a/guide/start/concept-quickstart.md +++ b/guide/start/concept-quickstart.md @@ -5,7 +5,7 @@ menu_parent: index.md --- # {{ page.title }} -The following section provides a quick summary of the main Brooklyn concepts you will encounter in Getting Started. For further discussion of these concepts see [The Theory Behind Brooklyn]({{book.path.website}}/learnmore/theory.html), and the detailed descriptions in [Brooklyn Concepts]({{book.path.guide}}/concepts/). +The following section provides a quick summary of the main Brooklyn concepts you will encounter in Getting Started. For further discussion of these concepts see [The Theory Behind Brooklyn]({{book.path.website}}/learnmore/theory.html), and the detailed descriptions in [Brooklyn Concepts](../concepts/index.md). ***Deployment and Management*** Brooklyn is built for agile deployment of applications across cloud and other targets, and real-time autonomic management. "Autonomic computing" is the concept of components looking after themselves where possible (self-healing, self-optimizing, etc). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9647d82e/guide/start/running.md ---------------------------------------------------------------------- diff --git a/guide/start/running.md b/guide/start/running.md index 2d1eaf8..c6a47fa 100644 --- a/guide/start/running.md +++ b/guide/start/running.md @@ -212,7 +212,7 @@ using the most appropriate link for your OS: * [OSX](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn_version}}/apache-brooklyn-{{book.brooklyn_version}}-client-cli-macosx.tar.gz) {% endif %} -For details on the CLI, see the [Client CLI Reference]({{ book.path.guide }}/ops/cli/) page. +For details on the CLI, see the [Client CLI Reference](../ops/cli/index.md) page. {% if output.name == 'website' %} ## Next
