move subdir from incubator up a level as it is promoted to its own repo (first non-incubator commit!)
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/6e86cb02 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/6e86cb02 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/6e86cb02 Branch: refs/heads/master Commit: 6e86cb02081706c6d098c6f873d388d378e61471 Parents: 25b04fb Author: Alex Heneveld <[email protected]> Authored: Sat Jan 30 14:30:15 2016 +0000 Committer: Alex Heneveld <[email protected]> Committed: Sat Jan 30 14:30:15 2016 +0000 ---------------------------------------------------------------------- .gitignore | 4 + Gemfile | 11 + Gemfile.lock | 98 + README.md | 289 + _build/build.sh | 309 + _build/config-exclude-all-but-guide.yml | 1 + _build/config-exclude-guide.yml | 1 + _build/config-exclude-root-index.yml | 1 + _build/config-guide-latest.yml | 3 + _build/config-guide-root.yml | 2 + _build/config-guide-version.yml | 6 + _build/config-production.yml | 6 + _build/config-pygments.yml | 28 + _build/config-rdiscount.yml | 28 + _build/config-style-latest.yml | 2 + _build/config-subpath-brooklyn.yml | 9 + _build/config-website-root.yml | 3 + _build/help.txt | 22 + _build/htmlproof-brooklyn.sh | 21 + _build/javadoc-overview.html | 22 + _build/list-objects-logback.xml | 42 + _build/make-javadoc.sh | 60 + _build/quick-make-few-javadoc.sh | 6 + _build/serve-public-site.sh | 1 + _build/serve-site.sh | 1 + _build/tests/jsonball/test_jsonball.md | 18 + _build/tests/jsonball/test_jsonball_file.json | 1 + _build/tests/jsonball/test_jsonball_page.json | 2 + _build/tests/jsonball/toc.json | 6 + _config.yml | 54 + _extra/big_examples/before-begin.include.md | 56 + .../console-geoscaling-details-w700.png | Bin 0 -> 167441 bytes .../console-geoscaling-details.png | Bin 0 -> 176651 bytes .../global-web-fabric/console-map-w700.png | Bin 0 -> 201060 bytes .../global-web-fabric/console-map.png | Bin 0 -> 331520 bytes .../geopaas-deployed-app-w700.png | Bin 0 -> 153738 bytes .../global-web-fabric/geopaas-deployed-app.png | Bin 0 -> 114615 bytes _extra/big_examples/global-web-fabric/index.md | 378 + _extra/big_examples/index.md | 18 + _extra/big_examples/messaging/index.md | 181 + .../nosql-cassandra/cassandra.include.md | 282 + _extra/big_examples/nosql-cassandra/index.md | 7 + _extra/big_examples/simple-web-cluster.md | 9 + _extra/big_examples/toc.json | 13 + _extra/big_examples/webcluster.md | 9 + _extra/big_examples/webcluster/index.md | 7 + .../webcluster/webcluster.include.md | 124 + _extra/brooklyn-gpg-public-key.asc | 21 + _extra/deploying-yaml.md | 39 + _extra/highlevel1.md | 50 + _extra/list-of-blueprints.md | 160 + _extra/local-artifact-repo.md | 32 + .../example_files/tomcat_multi-location.java | 15 + .../example_files/tomcat_nginx.java | 17 + .../example_files/tomcat_simple.java | 9 + _extra/simple_java_examples/examples.md | 121 + _extra/update-docs.md | 14 + _includes/base-head.html | 30 + _includes/base-scss.scss | 36 + _includes/feature-image.html | 4 + _includes/feature-item-end.html | 14 + _includes/feature-item.html | 4 + _includes/fields.md | 32 + _includes/footer.html | 16 + _includes/java_link.html | 18 + _includes/list-children.html | 9 + _includes/sidemenu.html | 244 + _includes/sitemap-item.html | 36 + _includes/topmenu.html | 75 + _layouts/base.html | 186 + _layouts/website-base.html | 33 + _layouts/website-landing.html | 43 + _layouts/website-normal.html | 39 + _licensing/README | 24 + _plugins/brooklyn_jekyll_util.rb | 129 + _plugins/brooklyn_metadata.rb | 64 + _plugins/dependency_url.rb | 31 + _plugins/json.rb | 27 + _plugins/jsonball.rb | 103 + _plugins/read.rb | 81 + _plugins/site_structure.rb | 344 + _plugins/trim.rb | 25 + brooklyn-docs/.gitattributes | 6 - brooklyn-docs/.gitignore | 36 - brooklyn-docs/Gemfile | 11 - brooklyn-docs/Gemfile.lock | 98 - brooklyn-docs/LICENSE | 455 - brooklyn-docs/NOTICE | 5 - brooklyn-docs/README.md | 289 - brooklyn-docs/_build/build.sh | 309 - .../_build/config-exclude-all-but-guide.yml | 1 - brooklyn-docs/_build/config-exclude-guide.yml | 1 - .../_build/config-exclude-root-index.yml | 1 - brooklyn-docs/_build/config-guide-latest.yml | 3 - brooklyn-docs/_build/config-guide-root.yml | 2 - brooklyn-docs/_build/config-guide-version.yml | 6 - brooklyn-docs/_build/config-production.yml | 6 - brooklyn-docs/_build/config-pygments.yml | 28 - brooklyn-docs/_build/config-rdiscount.yml | 28 - brooklyn-docs/_build/config-style-latest.yml | 2 - .../_build/config-subpath-brooklyn.yml | 9 - brooklyn-docs/_build/config-website-root.yml | 3 - brooklyn-docs/_build/help.txt | 22 - brooklyn-docs/_build/htmlproof-brooklyn.sh | 21 - brooklyn-docs/_build/javadoc-overview.html | 22 - brooklyn-docs/_build/list-objects-logback.xml | 42 - brooklyn-docs/_build/make-javadoc.sh | 60 - brooklyn-docs/_build/quick-make-few-javadoc.sh | 6 - brooklyn-docs/_build/serve-public-site.sh | 1 - brooklyn-docs/_build/serve-site.sh | 1 - .../_build/tests/jsonball/test_jsonball.md | 18 - .../tests/jsonball/test_jsonball_file.json | 1 - .../tests/jsonball/test_jsonball_page.json | 2 - brooklyn-docs/_build/tests/jsonball/toc.json | 6 - brooklyn-docs/_config.yml | 54 - .../_extra/big_examples/before-begin.include.md | 56 - .../console-geoscaling-details-w700.png | Bin 167441 -> 0 bytes .../console-geoscaling-details.png | Bin 176651 -> 0 bytes .../global-web-fabric/console-map-w700.png | Bin 201060 -> 0 bytes .../global-web-fabric/console-map.png | Bin 331520 -> 0 bytes .../geopaas-deployed-app-w700.png | Bin 153738 -> 0 bytes .../global-web-fabric/geopaas-deployed-app.png | Bin 114615 -> 0 bytes .../big_examples/global-web-fabric/index.md | 378 - brooklyn-docs/_extra/big_examples/index.md | 18 - .../_extra/big_examples/messaging/index.md | 181 - .../nosql-cassandra/cassandra.include.md | 282 - .../big_examples/nosql-cassandra/index.md | 7 - .../_extra/big_examples/simple-web-cluster.md | 9 - brooklyn-docs/_extra/big_examples/toc.json | 13 - brooklyn-docs/_extra/big_examples/webcluster.md | 9 - .../_extra/big_examples/webcluster/index.md | 7 - .../webcluster/webcluster.include.md | 124 - .../_extra/brooklyn-gpg-public-key.asc | 21 - brooklyn-docs/_extra/deploying-yaml.md | 39 - brooklyn-docs/_extra/highlevel1.md | 50 - brooklyn-docs/_extra/list-of-blueprints.md | 160 - brooklyn-docs/_extra/local-artifact-repo.md | 32 - .../example_files/tomcat_multi-location.java | 15 - .../example_files/tomcat_nginx.java | 17 - .../example_files/tomcat_simple.java | 9 - .../_extra/simple_java_examples/examples.md | 121 - brooklyn-docs/_extra/update-docs.md | 14 - brooklyn-docs/_includes/base-head.html | 30 - brooklyn-docs/_includes/base-scss.scss | 36 - brooklyn-docs/_includes/feature-image.html | 4 - brooklyn-docs/_includes/feature-item-end.html | 14 - brooklyn-docs/_includes/feature-item.html | 4 - brooklyn-docs/_includes/fields.md | 32 - brooklyn-docs/_includes/footer.html | 16 - brooklyn-docs/_includes/java_link.html | 18 - brooklyn-docs/_includes/list-children.html | 9 - brooklyn-docs/_includes/sidemenu.html | 244 - brooklyn-docs/_includes/sitemap-item.html | 36 - brooklyn-docs/_includes/topmenu.html | 75 - brooklyn-docs/_layouts/base.html | 186 - brooklyn-docs/_layouts/website-base.html | 33 - brooklyn-docs/_layouts/website-landing.html | 43 - brooklyn-docs/_layouts/website-normal.html | 39 - brooklyn-docs/_licensing/README | 24 - brooklyn-docs/_plugins/brooklyn_jekyll_util.rb | 129 - brooklyn-docs/_plugins/brooklyn_metadata.rb | 64 - brooklyn-docs/_plugins/dependency_url.rb | 31 - brooklyn-docs/_plugins/json.rb | 27 - brooklyn-docs/_plugins/jsonball.rb | 103 - brooklyn-docs/_plugins/read.rb | 81 - brooklyn-docs/_plugins/site_structure.rb | 344 - brooklyn-docs/_plugins/trim.rb | 25 - brooklyn-docs/favicon.ico | Bin 1150 -> 0 bytes .../concepts/application-parent-membership.md | 25 - ...ooklyn-flow-websequencediagrams.com-w400.png | Bin 58518 -> 0 bytes .../brooklyn-flow-websequencediagrams.com.png | Bin 106928 -> 0 bytes .../concepts/configuration-sensor-effectors.md | 40 - .../guide/concepts/dependent-configuration.md | 34 - brooklyn-docs/guide/concepts/entities.md | 23 - brooklyn-docs/guide/concepts/execution.md | 34 - brooklyn-docs/guide/concepts/index.md | 22 - .../concepts/lifecycle-managementcontext.md | 44 - brooklyn-docs/guide/concepts/location.md | 22 - brooklyn-docs/guide/concepts/policies.md | 11 - .../concepts/stop-start-restart-behaviour.md | 65 - brooklyn-docs/guide/dev/code/index.md | 97 - brooklyn-docs/guide/dev/code/licensing.md | 122 - brooklyn-docs/guide/dev/code/tests.md | 31 - .../guide/dev/env/ide/eclipse.include.md | 6 - brooklyn-docs/guide/dev/env/ide/index.md | 108 - brooklyn-docs/guide/dev/env/index.md | 13 - brooklyn-docs/guide/dev/env/maven-build.md | 180 - brooklyn-docs/guide/dev/index.md | 39 - .../guide/dev/tips/debugging-remote-brooklyn.md | 138 - brooklyn-docs/guide/dev/tips/index.md | 59 - brooklyn-docs/guide/dev/tips/logging.md | 143 - brooklyn-docs/guide/glossary.json | 22 - brooklyn-docs/guide/index.md | 21 - brooklyn-docs/guide/java/archetype.md | 64 - brooklyn-docs/guide/java/common-usage.md | 140 - .../guide/java/defining-and-deploying.md | 125 - brooklyn-docs/guide/java/entities.md | 223 - brooklyn-docs/guide/java/entitlements.md | 42 - brooklyn-docs/guide/java/entity.md | 90 - brooklyn-docs/guide/java/index.md | 23 - brooklyn-docs/guide/java/policies.md | 73 - brooklyn-docs/guide/java/policy.md | 77 - brooklyn-docs/guide/java/service-state.md | 73 - ...topology-dependencies-management-policies.md | 69 - .../guide/java/wt-deployed-application-700.png | Bin 176494 -> 0 bytes .../guide/java/wt-deployed-application.png | Bin 127347 -> 0 bytes brooklyn-docs/guide/java/wt-starting-700.png | Bin 303892 -> 0 bytes brooklyn-docs/guide/java/wt-starting.png | Bin 332710 -> 0 bytes .../guide/java/wt-tree-jboss-sensors-700.png | Bin 268853 -> 0 bytes .../guide/java/wt-tree-jboss-sensors.png | Bin 169929 -> 0 bytes brooklyn-docs/guide/misc/download.md | 175 - brooklyn-docs/guide/misc/index.md | 21 - brooklyn-docs/guide/misc/javadoc/index.md | 11 - brooklyn-docs/guide/misc/known-issues.md | 27 - .../guide/misc/migrate-to-0.8.0-regexes.sed | 1394 --- brooklyn-docs/guide/misc/migrate-to-0.8.0.md | 32 - brooklyn-docs/guide/misc/release-notes.md | 72 - brooklyn-docs/guide/ops/brooklyn_properties.md | 236 - .../guide/ops/catalog/images/add-to-catalog.png | Bin 4919 -> 0 bytes brooklyn-docs/guide/ops/catalog/index.md | 325 - .../guide/ops/catalog/mysql-in-catalog-w700.png | Bin 92767 -> 0 bytes .../guide/ops/catalog/mysql-in-catalog.png | Bin 168831 -> 0 bytes brooklyn-docs/guide/ops/cli/cli-ref-guide.md | 313 - brooklyn-docs/guide/ops/cli/cli-usage-guide.md | 483 - brooklyn-docs/guide/ops/cli/index.md | 12 - .../guide/ops/externalized-configuration.md | 253 - .../guide/ops/gui/_my-web-cluster.yaml | 23 - .../guide/ops/gui/_my-web-cluster2.yaml | 31 - brooklyn-docs/guide/ops/gui/blueprints.md | 68 - ...cation-catalog-web-cluster-with-db-large.png | Bin 165148 -> 0 bytes ...talog-web-cluster-with-db-location-large.png | Bin 152721 -> 0 bytes ...ion-catalog-web-cluster-with-db-location.png | Bin 86425 -> 0 bytes ...-application-catalog-web-cluster-with-db.png | Bin 70109 -> 0 bytes .../images/add-application-modal-yaml-large.png | Bin 124297 -> 0 bytes .../gui/images/add-application-modal-yaml.png | Bin 55183 -> 0 bytes .../ops/gui/images/home-app-starting-large.png | Bin 490707 -> 0 bytes .../guide/ops/gui/images/home-app-starting.png | Bin 188754 -> 0 bytes .../gui/images/my-db-activities-step1-large.png | Bin 99671 -> 0 bytes .../ops/gui/images/my-db-activities-step1.png | Bin 57813 -> 0 bytes .../gui/images/my-db-activities-step2-large.png | Bin 176900 -> 0 bytes .../ops/gui/images/my-db-activities-step2.png | Bin 97061 -> 0 bytes .../gui/images/my-db-activities-step3-large.png | Bin 162986 -> 0 bytes .../ops/gui/images/my-db-activities-step3.png | Bin 84365 -> 0 bytes .../ops/gui/images/my-web-cluster-starting.png | Bin 32948 -> 0 bytes .../my-web-cluster-stop-confirm-large.png | Bin 148155 -> 0 bytes .../gui/images/my-web-cluster-stop-confirm.png | Bin 79280 -> 0 bytes .../guide/ops/gui/images/my-web-large.png | Bin 104519 -> 0 bytes .../ops/gui/images/my-web-summary-large.png | Bin 178785 -> 0 bytes .../guide/ops/gui/images/my-web-summary.png | Bin 80583 -> 0 bytes .../my-web-validating-app-endpoint-large.png | Bin 123007 -> 0 bytes .../images/my-web-validating-app-endpoint.png | Bin 68969 -> 0 bytes brooklyn-docs/guide/ops/gui/images/my-web.png | Bin 58849 -> 0 bytes brooklyn-docs/guide/ops/gui/index.md | 11 - brooklyn-docs/guide/ops/gui/managing.md | 70 - brooklyn-docs/guide/ops/gui/policies.md | 49 - brooklyn-docs/guide/ops/gui/running.md | 50 - brooklyn-docs/guide/ops/high-availability.md | 51 - brooklyn-docs/guide/ops/index.md | 22 - .../guide/ops/locations/cloud-credentials.md | 85 - brooklyn-docs/guide/ops/locations/index.md | 420 - .../guide/ops/locations/location-customizers.md | 152 - .../guide/ops/locations/more-locations.md | 55 - brooklyn-docs/guide/ops/locations/ssh-keys.md | 85 - brooklyn-docs/guide/ops/locations/vpc-issues.md | 32 - brooklyn-docs/guide/ops/logging.md | 72 - brooklyn-docs/guide/ops/persistence/index.md | 379 - .../guide/ops/production-installation.md | 103 - brooklyn-docs/guide/ops/requirements.md | 70 - brooklyn-docs/guide/ops/rest.md | 89 - brooklyn-docs/guide/ops/security-guidelines.md | 102 - brooklyn-docs/guide/ops/server-cli-reference.md | 204 - .../guide/ops/troubleshooting/connectivity.md | 154 - .../guide/ops/troubleshooting/deployment.md | 88 - .../going-deep-in-java-and-logs.md | 484 - .../images/external-error-large.png | Bin 131907 -> 0 bytes .../troubleshooting/images/external-error.png | Bin 71972 -> 0 bytes .../images/failed-task-large.png | Bin 169079 -> 0 bytes .../ops/troubleshooting/images/failed-task.png | Bin 92530 -> 0 bytes .../images/jmx-sensors-all-large.png | Bin 133517 -> 0 bytes .../troubleshooting/images/jmx-sensors-all.png | Bin 76581 -> 0 bytes .../images/jmx-sensors-large.png | Bin 197177 -> 0 bytes .../ops/troubleshooting/images/jmx-sensors.png | Bin 109139 -> 0 bytes .../images/resource-exception-large.png | Bin 134842 -> 0 bytes .../images/resource-exception.png | Bin 76059 -> 0 bytes .../images/script-failure-large.png | Bin 130227 -> 0 bytes .../troubleshooting/images/script-failure.png | Bin 71912 -> 0 bytes .../guide/ops/troubleshooting/index.md | 12 - .../guide/ops/troubleshooting/overview.md | 116 - .../ops/troubleshooting/softwareprocess.md | 51 - brooklyn-docs/guide/start/_my-web-cluster.yaml | 23 - brooklyn-docs/guide/start/_my-web-cluster2.yaml | 31 - brooklyn-docs/guide/start/blueprints.md | 132 - brooklyn-docs/guide/start/brooklyn.properties | 337 - brooklyn-docs/guide/start/concept-quickstart.md | 33 - ...cation-catalog-web-cluster-with-db-large.png | Bin 165148 -> 0 bytes ...talog-web-cluster-with-db-location-large.png | Bin 152721 -> 0 bytes ...ion-catalog-web-cluster-with-db-location.png | Bin 86425 -> 0 bytes ...-application-catalog-web-cluster-with-db.png | Bin 70109 -> 0 bytes .../images/add-application-modal-yaml-large.png | Bin 124297 -> 0 bytes .../start/images/add-application-modal-yaml.png | Bin 55183 -> 0 bytes .../images/my-db-activities-step1-large.png | Bin 99671 -> 0 bytes .../start/images/my-db-activities-step1.png | Bin 57813 -> 0 bytes .../images/my-db-activities-step2-large.png | Bin 176900 -> 0 bytes .../start/images/my-db-activities-step2.png | Bin 97061 -> 0 bytes .../images/my-db-activities-step3-large.png | Bin 162986 -> 0 bytes .../start/images/my-db-activities-step3.png | Bin 84365 -> 0 bytes .../start/images/my-web-cluster-starting.png | Bin 32948 -> 0 bytes .../my-web-cluster-stop-confirm-large.png | Bin 148155 -> 0 bytes .../images/my-web-cluster-stop-confirm.png | Bin 79280 -> 0 bytes .../guide/start/images/my-web-large.png | Bin 104519 -> 0 bytes .../guide/start/images/my-web-summary-large.png | Bin 178785 -> 0 bytes .../guide/start/images/my-web-summary.png | Bin 80583 -> 0 bytes .../my-web-validating-app-endpoint-large.png | Bin 123007 -> 0 bytes .../images/my-web-validating-app-endpoint.png | Bin 68969 -> 0 bytes brooklyn-docs/guide/start/images/my-web.png | Bin 58849 -> 0 bytes brooklyn-docs/guide/start/index.md | 14 - brooklyn-docs/guide/start/managing.md | 494 - brooklyn-docs/guide/start/policies.md | 177 - brooklyn-docs/guide/start/running.md | 135 - brooklyn-docs/guide/yaml/advanced-example.md | 180 - brooklyn-docs/guide/yaml/blueprinting-tips.md | 105 - brooklyn-docs/guide/yaml/chef/about-chef.md | 50 - .../yaml/chef/advanced-chef-integration.md | 48 - .../guide/yaml/chef/chef-call-flow.png | Bin 36222 -> 0 bytes .../guide/yaml/chef/creating-blueprints.md | 105 - .../yaml/chef/example_yaml/mysql-chef-1.yaml | 24 - .../yaml/chef/example_yaml/mysql-chef-2.yaml | 28 - brooklyn-docs/guide/yaml/chef/index.md | 18 - brooklyn-docs/guide/yaml/chef/writing-chef.md | 79 - .../guide/yaml/clusters-and-policies.md | 42 - brooklyn-docs/guide/yaml/clusters.md | 34 - brooklyn-docs/guide/yaml/configuring-vms.md | 31 - brooklyn-docs/guide/yaml/creating-yaml.md | 78 - brooklyn-docs/guide/yaml/custom-entities.md | 238 - .../appserver-clustered-w-db-concise.yaml | 15 - .../example_yaml/appserver-clustered-w-db.yaml | 18 - .../appserver-configured-in-config.yaml | 6 - .../yaml/example_yaml/appserver-configured.yaml | 5 - .../appserver-w-db-other-flavor.yaml | 17 - .../guide/yaml/example_yaml/appserver-w-db.yaml | 15 - .../yaml/example_yaml/appserver-w-policy.yaml | 26 - .../brooklyn-elasticsearch-catalog.bom | 124 - .../yaml/example_yaml/brooklyn-elk-catalog.bom | 35 - .../example_yaml/brooklyn-kibana-catalog.bom | 52 - .../example_yaml/brooklyn-logstash-catalog.bom | 59 - .../guide/yaml/example_yaml/cluster-vm.yaml | 12 - .../simple-appserver-with-location-byon.yaml | 12 - .../simple-appserver-with-location.yaml | 8 - .../yaml/example_yaml/simple-appserver.yaml | 4 - .../guide/yaml/example_yaml/simple-vm.yaml | 8 - ...est-app-with-enrichers-slightly-simpler.yaml | 57 - .../vanilla-bash-netcat-catalog.bom | 35 - .../vanilla-bash-netcat-cluster.yaml | 11 - .../example_yaml/vanilla-bash-netcat-file.yaml | 6 - .../vanilla-bash-netcat-more-commands.yaml | 16 - .../vanilla-bash-netcat-port-parameter.yaml | 21 - .../example_yaml/vanilla-bash-netcat-port.yaml | 13 - .../vanilla-bash-netcat-reference.yaml | 5 - .../vanilla-bash-netcat-restarter.yaml | 20 - .../vanilla-bash-netcat-w-client.yaml | 78 - .../yaml/example_yaml/vanilla-bash-netcat.yaml | 8 - brooklyn-docs/guide/yaml/index.md | 22 - brooklyn-docs/guide/yaml/multiple-services.md | 97 - brooklyn-docs/guide/yaml/setting-locations.md | 45 - ...infrastructuredeploymenttestcase-entity.yaml | 11 - .../entities/loopovergroupmembers-entity.yaml | 6 - .../entities/paralleltestcase-entity.yaml | 6 - .../yaml/test/example_yaml/entities/script1.sh | 2 - .../entities/simpleshellcommandtest-entity.yaml | 24 - .../example_yaml/entities/testcase-entity.yaml | 6 - .../entities/testeffector-entity.yaml | 8 - .../entities/testhttpcall-entity.yaml | 7 - .../entities/testsensor-entity.yaml | 7 - .../testcases/effector-test-snippet.yaml | 28 - .../testcases/getting-started-test-example.yaml | 71 - .../testcases/http-test-snippet.yaml | 20 - .../testcases/sensor-test-snippet.yaml | 7 - .../getting-started-blueprint-test-large.png | Bin 156553 -> 0 bytes .../images/getting-started-blueprint-test.png | Bin 84906 -> 0 bytes brooklyn-docs/guide/yaml/test/index.md | 29 - brooklyn-docs/guide/yaml/test/test-entities.md | 156 - brooklyn-docs/guide/yaml/test/usage-examples.md | 58 - .../guide/yaml/web-console-yaml-700.png | Bin 138229 -> 0 bytes brooklyn-docs/guide/yaml/web-console-yaml.png | Bin 661136 -> 0 bytes brooklyn-docs/guide/yaml/winrm/index.md | 526 - brooklyn-docs/guide/yaml/yaml-reference.md | 239 - brooklyn-docs/index.md | 19 - brooklyn-docs/style/css/_archive_warning.scss | 31 - brooklyn-docs/style/css/_basic.scss | 62 - brooklyn-docs/style/css/_blueprint_tour.scss | 181 - brooklyn-docs/style/css/_code_blocks.scss | 98 - brooklyn-docs/style/css/_feature_list.scss | 60 - brooklyn-docs/style/css/_footer.scss | 36 - brooklyn-docs/style/css/_landing.scss | 26 - brooklyn-docs/style/css/_main_container.scss | 84 - brooklyn-docs/style/css/_menu.scss | 201 - brooklyn-docs/style/css/_search.scss | 29 - brooklyn-docs/style/css/_tooltips.scss | 14 - brooklyn-docs/style/css/_util.scss | 27 - brooklyn-docs/style/css/catalog_items.css | 152 - brooklyn-docs/style/css/code.css | 79 - brooklyn-docs/style/css/javadoc.scss | 119 - brooklyn-docs/style/css/website.scss | 20 - brooklyn-docs/style/deps/README.md | 3 - .../glyphicons-halflings-regular.eot | Bin 20335 -> 0 bytes .../glyphicons-halflings-regular.svg | 229 - .../glyphicons-halflings-regular.ttf | Bin 41280 -> 0 bytes .../glyphicons-halflings-regular.woff | Bin 23320 -> 0 bytes brooklyn-docs/style/deps/bootstrap-theme.css | 346 - brooklyn-docs/style/deps/bootstrap.css | 5784 ----------- brooklyn-docs/style/deps/bootstrap.js | 1951 ---- brooklyn-docs/style/deps/bootstrap.min.css | 7 - brooklyn-docs/style/deps/bootstrap.min.js | 6 - .../style/deps/font-awesome-4.2.0/_LICENSE | 1 - .../font-awesome-4.2.0/css/font-awesome.css | 1672 ---- .../font-awesome-4.2.0/css/font-awesome.min.css | 4 - .../font-awesome-4.2.0/fonts/FontAwesome.otf | Bin 85908 -> 0 bytes .../fonts/fontawesome-webfont.eot | Bin 56006 -> 0 bytes .../fonts/fontawesome-webfont.svg | 520 - .../fonts/fontawesome-webfont.ttf | Bin 112160 -> 0 bytes .../fonts/fontawesome-webfont.woff | Bin 65452 -> 0 bytes .../less/bordered-pulled.less | 16 - .../deps/font-awesome-4.2.0/less/core.less | 11 - .../font-awesome-4.2.0/less/fixed-width.less | 6 - .../font-awesome-4.2.0/less/font-awesome.less | 17 - .../deps/font-awesome-4.2.0/less/icons.less | 552 -- .../deps/font-awesome-4.2.0/less/larger.less | 13 - .../deps/font-awesome-4.2.0/less/list.less | 19 - .../deps/font-awesome-4.2.0/less/mixins.less | 25 - .../deps/font-awesome-4.2.0/less/path.less | 14 - .../less/rotated-flipped.less | 20 - .../deps/font-awesome-4.2.0/less/spinning.less | 29 - .../deps/font-awesome-4.2.0/less/stacked.less | 20 - .../deps/font-awesome-4.2.0/less/variables.less | 561 -- .../scss/_bordered-pulled.scss | 16 - .../deps/font-awesome-4.2.0/scss/_core.scss | 11 - .../font-awesome-4.2.0/scss/_fixed-width.scss | 6 - .../deps/font-awesome-4.2.0/scss/_icons.scss | 552 -- .../deps/font-awesome-4.2.0/scss/_larger.scss | 13 - .../deps/font-awesome-4.2.0/scss/_list.scss | 19 - .../deps/font-awesome-4.2.0/scss/_mixins.scss | 25 - .../deps/font-awesome-4.2.0/scss/_path.scss | 14 - .../scss/_rotated-flipped.scss | 20 - .../deps/font-awesome-4.2.0/scss/_spinning.scss | 29 - .../deps/font-awesome-4.2.0/scss/_stacked.scss | 20 - .../font-awesome-4.2.0/scss/_variables.scss | 561 -- .../font-awesome-4.2.0/scss/font-awesome.scss | 17 - brooklyn-docs/style/deps/glossarizer.js | 379 - .../images/ui-bg_flat_0_aaaaaa_40x100.png | Bin 180 -> 0 bytes .../images/ui-bg_flat_75_ffffff_40x100.png | Bin 178 -> 0 bytes .../images/ui-bg_glass_55_fbf9ee_1x400.png | Bin 120 -> 0 bytes .../images/ui-bg_glass_65_ffffff_1x400.png | Bin 105 -> 0 bytes .../images/ui-bg_glass_75_dadada_1x400.png | Bin 111 -> 0 bytes .../images/ui-bg_glass_75_e6e6e6_1x400.png | Bin 110 -> 0 bytes .../images/ui-bg_glass_95_fef1ec_1x400.png | Bin 119 -> 0 bytes .../ui-bg_highlight-soft_75_cccccc_1x100.png | Bin 101 -> 0 bytes .../images/ui-icons_222222_256x240.png | Bin 4369 -> 0 bytes .../images/ui-icons_2e83ff_256x240.png | Bin 4369 -> 0 bytes .../images/ui-icons_454545_256x240.png | Bin 4369 -> 0 bytes .../images/ui-icons_888888_256x240.png | Bin 4369 -> 0 bytes .../images/ui-icons_cd0a0a_256x240.png | Bin 4369 -> 0 bytes .../deps/jquery-ui/jquery-ui-1.8.18.custom.css | 565 -- .../jquery-ui/jquery-ui-1.8.18.custom.min.js | 356 - brooklyn-docs/style/deps/jquery.cookie.js | 94 - brooklyn-docs/style/deps/jquery.js | 9190 ------------------ brooklyn-docs/style/deps/jquery.min.js | 4 - brooklyn-docs/style/deps/octicons/LICENSE.txt | 9 - brooklyn-docs/style/deps/octicons/README.md | 1 - .../style/deps/octicons/octicons-local.ttf | Bin 52764 -> 0 bytes brooklyn-docs/style/deps/octicons/octicons.css | 235 - brooklyn-docs/style/deps/octicons/octicons.eot | Bin 31440 -> 0 bytes brooklyn-docs/style/deps/octicons/octicons.less | 233 - brooklyn-docs/style/deps/octicons/octicons.svg | 198 - brooklyn-docs/style/deps/octicons/octicons.ttf | Bin 31272 -> 0 bytes brooklyn-docs/style/deps/octicons/octicons.woff | Bin 17492 -> 0 bytes .../style/deps/octicons/sprockets-octicons.scss | 230 - brooklyn-docs/style/deps/superfish.js | 121 - brooklyn-docs/style/deps/tooltip.css | 64 - brooklyn-docs/style/deps/tooltip.js | 86 - brooklyn-docs/style/deps/underscore-min.js | 6 - brooklyn-docs/style/deps/underscore-min.map | 1 - .../img/apache-brooklyn-logo-244px-wide.png | Bin 4892 -> 0 bytes .../img/apache-brooklyn-logo-817px-wide.png | Bin 10688 -> 0 bytes .../style/img/bridge-large-no-title.png | Bin 66113 -> 0 bytes brooklyn-docs/style/img/bridge.png | Bin 20450 -> 0 bytes brooklyn-docs/style/img/brooklyn.gif | Bin 4873 -> 0 bytes .../style/img/clipboard-green-click.png | Bin 51832 -> 0 bytes .../style/img/clipboard-green-hover.png | Bin 51473 -> 0 bytes .../style/img/clipboard-green-normal.png | Bin 61853 -> 0 bytes brooklyn-docs/style/img/clipboard.png | Bin 3981 -> 0 bytes brooklyn-docs/style/img/divider-quicklinks.gif | Bin 817 -> 0 bytes brooklyn-docs/style/img/feather.png | Bin 40042 -> 0 bytes brooklyn-docs/style/img/github-1024-black.png | Bin 15613 -> 0 bytes brooklyn-docs/style/img/github-256-black.png | Bin 12166 -> 0 bytes brooklyn-docs/style/img/github-256-green.png | Bin 13875 -> 0 bytes brooklyn-docs/style/img/irc-256-black.png | Bin 4446 -> 0 bytes brooklyn-docs/style/img/irc-256-green.png | Bin 5731 -> 0 bytes brooklyn-docs/style/img/irc-icon.graffle | 640 -- brooklyn-docs/style/img/ok.png | Bin 595 -> 0 bytes brooklyn-docs/style/img/twitter-256-black.png | Bin 10590 -> 0 bytes brooklyn-docs/style/img/twitter-256-green.png | Bin 11732 -> 0 bytes brooklyn-docs/style/img/twitter-4096-black.png | Bin 45680 -> 0 bytes brooklyn-docs/style/img/warning.png | Bin 29886 -> 0 bytes brooklyn-docs/style/js/_readme.txt | 2 - brooklyn-docs/style/js/catalog/bloodhound.js | 727 -- brooklyn-docs/style/js/catalog/common.js | 103 - brooklyn-docs/style/js/underscore-min.js | 6 - brooklyn-docs/style/js/underscore-min.map | 1 - .../website/community/how-to-contribute-docs.md | 65 - brooklyn-docs/website/community/index.md | 73 - brooklyn-docs/website/community/irc.md | 14 - .../website/community/mailing-lists.md | 36 - .../website/developers/code-standards.md | 14 - .../website/developers/committers/index.md | 11 - .../committers/merging-contributed-code.md | 118 - .../committers/release-process/announce.md | 55 - .../release-process/environment-variables.md | 21 - .../committers/release-process/fix-release.md | 13 - .../committers/release-process/index.md | 30 - .../release-process/make-release-artifacts.md | 58 - .../committers/release-process/prerequisites.md | 136 - .../committers/release-process/publish-temp.md | 41 - .../committers/release-process/publish.md | 160 - .../release-process/release-version.md | 83 - .../release-process/verify-release-artifacts.md | 165 - .../committers/release-process/vote-ipmc.md | 99 - .../committers/release-process/vote.md | 139 - brooklyn-docs/website/developers/fork-after.png | Bin 134377 -> 0 bytes .../website/developers/fork-before.png | Bin 131674 -> 0 bytes brooklyn-docs/website/developers/fork-new.png | Bin 137626 -> 0 bytes .../website/developers/how-to-contribute.md | 109 - brooklyn-docs/website/developers/index.md | 46 - brooklyn-docs/website/developers/links.md | 22 - .../website/developers/pull-request.png | Bin 94166 -> 0 bytes brooklyn-docs/website/documentation/faq.md | 50 - brooklyn-docs/website/documentation/glossary.md | 92 - .../website/documentation/increase-entropy.md | 31 - brooklyn-docs/website/documentation/index.md | 30 - .../website/documentation/other-docs.md | 10 - brooklyn-docs/website/download/index.md | 99 - brooklyn-docs/website/download/verify.md | 151 - brooklyn-docs/website/index.md | 77 - .../website/learnmore/blueprint-tour.md | 191 - .../website/learnmore/catalog/catalog-item.html | 138 - .../website/learnmore/catalog/index.html | 161 - .../learnmore/features/blueprint-compose.png | Bin 15299 -> 0 bytes .../features/blueprint-machine-specs.png | Bin 16214 -> 0 bytes .../website/learnmore/features/blueprinting.md | 24 - .../website/learnmore/features/index.md | 18 - .../learnmore/features/java-hierarchy.png | Bin 106962 -> 0 bytes .../website/learnmore/features/java.md | 41 - .../website/learnmore/features/operations.md | 75 - .../website/learnmore/features/ops-console.png | Bin 491417 -> 0 bytes .../website/learnmore/features/ops-rest.png | Bin 62894 -> 0 bytes .../learnmore/features/policy-based-mgmt.md | 28 - brooklyn-docs/website/learnmore/index.md | 30 - brooklyn-docs/website/learnmore/theory.md | 184 - brooklyn-docs/website/meta/license.md | 205 - brooklyn-docs/website/meta/sitemap.md | 25 - brooklyn-docs/website/meta/versions.md | 98 - favicon.ico | Bin 0 -> 1150 bytes guide/concepts/application-parent-membership.md | 25 + ...ooklyn-flow-websequencediagrams.com-w400.png | Bin 0 -> 58518 bytes .../brooklyn-flow-websequencediagrams.com.png | Bin 0 -> 106928 bytes .../concepts/configuration-sensor-effectors.md | 40 + guide/concepts/dependent-configuration.md | 34 + guide/concepts/entities.md | 23 + guide/concepts/execution.md | 34 + guide/concepts/index.md | 22 + guide/concepts/lifecycle-managementcontext.md | 44 + guide/concepts/location.md | 22 + guide/concepts/policies.md | 11 + guide/concepts/stop-start-restart-behaviour.md | 65 + guide/dev/code/index.md | 97 + guide/dev/code/licensing.md | 122 + guide/dev/code/tests.md | 31 + guide/dev/env/ide/eclipse.include.md | 6 + guide/dev/env/ide/index.md | 108 + guide/dev/env/index.md | 13 + guide/dev/env/maven-build.md | 180 + guide/dev/index.md | 39 + guide/dev/tips/debugging-remote-brooklyn.md | 138 + guide/dev/tips/index.md | 59 + guide/dev/tips/logging.md | 143 + guide/glossary.json | 22 + guide/index.md | 21 + guide/java/archetype.md | 64 + guide/java/common-usage.md | 140 + guide/java/defining-and-deploying.md | 125 + guide/java/entities.md | 223 + guide/java/entitlements.md | 42 + guide/java/entity.md | 90 + guide/java/index.md | 23 + guide/java/policies.md | 73 + guide/java/policy.md | 77 + guide/java/service-state.md | 73 + ...topology-dependencies-management-policies.md | 69 + guide/java/wt-deployed-application-700.png | Bin 0 -> 176494 bytes guide/java/wt-deployed-application.png | Bin 0 -> 127347 bytes guide/java/wt-starting-700.png | Bin 0 -> 303892 bytes guide/java/wt-starting.png | Bin 0 -> 332710 bytes guide/java/wt-tree-jboss-sensors-700.png | Bin 0 -> 268853 bytes guide/java/wt-tree-jboss-sensors.png | Bin 0 -> 169929 bytes guide/misc/download.md | 175 + guide/misc/index.md | 21 + guide/misc/javadoc/index.md | 11 + guide/misc/known-issues.md | 27 + guide/misc/migrate-to-0.8.0-regexes.sed | 1394 +++ guide/misc/migrate-to-0.8.0.md | 32 + guide/misc/release-notes.md | 72 + guide/ops/brooklyn_properties.md | 236 + guide/ops/catalog/images/add-to-catalog.png | Bin 0 -> 4919 bytes guide/ops/catalog/index.md | 325 + guide/ops/catalog/mysql-in-catalog-w700.png | Bin 0 -> 92767 bytes guide/ops/catalog/mysql-in-catalog.png | Bin 0 -> 168831 bytes guide/ops/cli/cli-ref-guide.md | 313 + guide/ops/cli/cli-usage-guide.md | 483 + guide/ops/cli/index.md | 12 + guide/ops/externalized-configuration.md | 253 + guide/ops/gui/_my-web-cluster.yaml | 23 + guide/ops/gui/_my-web-cluster2.yaml | 31 + guide/ops/gui/blueprints.md | 68 + ...cation-catalog-web-cluster-with-db-large.png | Bin 0 -> 165148 bytes ...talog-web-cluster-with-db-location-large.png | Bin 0 -> 152721 bytes ...ion-catalog-web-cluster-with-db-location.png | Bin 0 -> 86425 bytes ...-application-catalog-web-cluster-with-db.png | Bin 0 -> 70109 bytes .../images/add-application-modal-yaml-large.png | Bin 0 -> 124297 bytes .../gui/images/add-application-modal-yaml.png | Bin 0 -> 55183 bytes .../ops/gui/images/home-app-starting-large.png | Bin 0 -> 490707 bytes guide/ops/gui/images/home-app-starting.png | Bin 0 -> 188754 bytes .../gui/images/my-db-activities-step1-large.png | Bin 0 -> 99671 bytes guide/ops/gui/images/my-db-activities-step1.png | Bin 0 -> 57813 bytes .../gui/images/my-db-activities-step2-large.png | Bin 0 -> 176900 bytes guide/ops/gui/images/my-db-activities-step2.png | Bin 0 -> 97061 bytes .../gui/images/my-db-activities-step3-large.png | Bin 0 -> 162986 bytes guide/ops/gui/images/my-db-activities-step3.png | Bin 0 -> 84365 bytes .../ops/gui/images/my-web-cluster-starting.png | Bin 0 -> 32948 bytes .../my-web-cluster-stop-confirm-large.png | Bin 0 -> 148155 bytes .../gui/images/my-web-cluster-stop-confirm.png | Bin 0 -> 79280 bytes guide/ops/gui/images/my-web-large.png | Bin 0 -> 104519 bytes guide/ops/gui/images/my-web-summary-large.png | Bin 0 -> 178785 bytes guide/ops/gui/images/my-web-summary.png | Bin 0 -> 80583 bytes .../my-web-validating-app-endpoint-large.png | Bin 0 -> 123007 bytes .../images/my-web-validating-app-endpoint.png | Bin 0 -> 68969 bytes guide/ops/gui/images/my-web.png | Bin 0 -> 58849 bytes guide/ops/gui/index.md | 11 + guide/ops/gui/managing.md | 70 + guide/ops/gui/policies.md | 49 + guide/ops/gui/running.md | 50 + guide/ops/high-availability.md | 51 + guide/ops/index.md | 22 + guide/ops/locations/cloud-credentials.md | 85 + guide/ops/locations/index.md | 420 + guide/ops/locations/location-customizers.md | 152 + guide/ops/locations/more-locations.md | 55 + guide/ops/locations/ssh-keys.md | 85 + guide/ops/locations/vpc-issues.md | 32 + guide/ops/logging.md | 72 + guide/ops/persistence/index.md | 379 + guide/ops/production-installation.md | 103 + guide/ops/requirements.md | 70 + guide/ops/rest.md | 89 + guide/ops/security-guidelines.md | 102 + guide/ops/server-cli-reference.md | 204 + guide/ops/troubleshooting/connectivity.md | 154 + guide/ops/troubleshooting/deployment.md | 88 + .../going-deep-in-java-and-logs.md | 484 + .../images/external-error-large.png | Bin 0 -> 131907 bytes .../troubleshooting/images/external-error.png | Bin 0 -> 71972 bytes .../images/failed-task-large.png | Bin 0 -> 169079 bytes .../ops/troubleshooting/images/failed-task.png | Bin 0 -> 92530 bytes .../images/jmx-sensors-all-large.png | Bin 0 -> 133517 bytes .../troubleshooting/images/jmx-sensors-all.png | Bin 0 -> 76581 bytes .../images/jmx-sensors-large.png | Bin 0 -> 197177 bytes .../ops/troubleshooting/images/jmx-sensors.png | Bin 0 -> 109139 bytes .../images/resource-exception-large.png | Bin 0 -> 134842 bytes .../images/resource-exception.png | Bin 0 -> 76059 bytes .../images/script-failure-large.png | Bin 0 -> 130227 bytes .../troubleshooting/images/script-failure.png | Bin 0 -> 71912 bytes guide/ops/troubleshooting/index.md | 12 + guide/ops/troubleshooting/overview.md | 116 + guide/ops/troubleshooting/softwareprocess.md | 51 + guide/start/_my-web-cluster.yaml | 23 + guide/start/_my-web-cluster2.yaml | 31 + guide/start/blueprints.md | 132 + guide/start/brooklyn.properties | 337 + guide/start/concept-quickstart.md | 33 + ...cation-catalog-web-cluster-with-db-large.png | Bin 0 -> 165148 bytes ...talog-web-cluster-with-db-location-large.png | Bin 0 -> 152721 bytes ...ion-catalog-web-cluster-with-db-location.png | Bin 0 -> 86425 bytes ...-application-catalog-web-cluster-with-db.png | Bin 0 -> 70109 bytes .../images/add-application-modal-yaml-large.png | Bin 0 -> 124297 bytes .../start/images/add-application-modal-yaml.png | Bin 0 -> 55183 bytes .../images/my-db-activities-step1-large.png | Bin 0 -> 99671 bytes guide/start/images/my-db-activities-step1.png | Bin 0 -> 57813 bytes .../images/my-db-activities-step2-large.png | Bin 0 -> 176900 bytes guide/start/images/my-db-activities-step2.png | Bin 0 -> 97061 bytes .../images/my-db-activities-step3-large.png | Bin 0 -> 162986 bytes guide/start/images/my-db-activities-step3.png | Bin 0 -> 84365 bytes guide/start/images/my-web-cluster-starting.png | Bin 0 -> 32948 bytes .../my-web-cluster-stop-confirm-large.png | Bin 0 -> 148155 bytes .../images/my-web-cluster-stop-confirm.png | Bin 0 -> 79280 bytes guide/start/images/my-web-large.png | Bin 0 -> 104519 bytes guide/start/images/my-web-summary-large.png | Bin 0 -> 178785 bytes guide/start/images/my-web-summary.png | Bin 0 -> 80583 bytes .../my-web-validating-app-endpoint-large.png | Bin 0 -> 123007 bytes .../images/my-web-validating-app-endpoint.png | Bin 0 -> 68969 bytes guide/start/images/my-web.png | Bin 0 -> 58849 bytes guide/start/index.md | 14 + guide/start/managing.md | 494 + guide/start/policies.md | 177 + guide/start/running.md | 135 + guide/yaml/advanced-example.md | 180 + guide/yaml/blueprinting-tips.md | 105 + guide/yaml/chef/about-chef.md | 50 + guide/yaml/chef/advanced-chef-integration.md | 48 + guide/yaml/chef/chef-call-flow.png | Bin 0 -> 36222 bytes guide/yaml/chef/creating-blueprints.md | 105 + guide/yaml/chef/example_yaml/mysql-chef-1.yaml | 24 + guide/yaml/chef/example_yaml/mysql-chef-2.yaml | 28 + guide/yaml/chef/index.md | 18 + guide/yaml/chef/writing-chef.md | 79 + guide/yaml/clusters-and-policies.md | 42 + guide/yaml/clusters.md | 34 + guide/yaml/configuring-vms.md | 31 + guide/yaml/creating-yaml.md | 78 + guide/yaml/custom-entities.md | 238 + .../appserver-clustered-w-db-concise.yaml | 15 + .../example_yaml/appserver-clustered-w-db.yaml | 18 + .../appserver-configured-in-config.yaml | 6 + .../yaml/example_yaml/appserver-configured.yaml | 5 + .../appserver-w-db-other-flavor.yaml | 17 + guide/yaml/example_yaml/appserver-w-db.yaml | 15 + guide/yaml/example_yaml/appserver-w-policy.yaml | 26 + .../brooklyn-elasticsearch-catalog.bom | 124 + .../yaml/example_yaml/brooklyn-elk-catalog.bom | 35 + .../example_yaml/brooklyn-kibana-catalog.bom | 52 + .../example_yaml/brooklyn-logstash-catalog.bom | 59 + guide/yaml/example_yaml/cluster-vm.yaml | 12 + .../simple-appserver-with-location-byon.yaml | 12 + .../simple-appserver-with-location.yaml | 8 + guide/yaml/example_yaml/simple-appserver.yaml | 4 + guide/yaml/example_yaml/simple-vm.yaml | 8 + ...est-app-with-enrichers-slightly-simpler.yaml | 57 + .../vanilla-bash-netcat-catalog.bom | 35 + .../vanilla-bash-netcat-cluster.yaml | 11 + .../example_yaml/vanilla-bash-netcat-file.yaml | 6 + .../vanilla-bash-netcat-more-commands.yaml | 16 + .../vanilla-bash-netcat-port-parameter.yaml | 21 + .../example_yaml/vanilla-bash-netcat-port.yaml | 13 + .../vanilla-bash-netcat-reference.yaml | 5 + .../vanilla-bash-netcat-restarter.yaml | 20 + .../vanilla-bash-netcat-w-client.yaml | 78 + .../yaml/example_yaml/vanilla-bash-netcat.yaml | 8 + guide/yaml/index.md | 22 + guide/yaml/multiple-services.md | 97 + guide/yaml/setting-locations.md | 45 + ...infrastructuredeploymenttestcase-entity.yaml | 11 + .../entities/loopovergroupmembers-entity.yaml | 6 + .../entities/paralleltestcase-entity.yaml | 6 + .../yaml/test/example_yaml/entities/script1.sh | 2 + .../entities/simpleshellcommandtest-entity.yaml | 24 + .../example_yaml/entities/testcase-entity.yaml | 6 + .../entities/testeffector-entity.yaml | 8 + .../entities/testhttpcall-entity.yaml | 7 + .../entities/testsensor-entity.yaml | 7 + .../testcases/effector-test-snippet.yaml | 28 + .../testcases/getting-started-test-example.yaml | 71 + .../testcases/http-test-snippet.yaml | 20 + .../testcases/sensor-test-snippet.yaml | 7 + .../getting-started-blueprint-test-large.png | Bin 0 -> 156553 bytes .../images/getting-started-blueprint-test.png | Bin 0 -> 84906 bytes guide/yaml/test/index.md | 29 + guide/yaml/test/test-entities.md | 156 + guide/yaml/test/usage-examples.md | 58 + guide/yaml/web-console-yaml-700.png | Bin 0 -> 138229 bytes guide/yaml/web-console-yaml.png | Bin 0 -> 661136 bytes guide/yaml/winrm/index.md | 526 + guide/yaml/yaml-reference.md | 239 + index.md | 19 + style/css/_archive_warning.scss | 31 + style/css/_basic.scss | 62 + style/css/_blueprint_tour.scss | 181 + style/css/_code_blocks.scss | 98 + style/css/_feature_list.scss | 60 + style/css/_footer.scss | 36 + style/css/_landing.scss | 26 + style/css/_main_container.scss | 84 + style/css/_menu.scss | 201 + style/css/_search.scss | 29 + style/css/_tooltips.scss | 14 + style/css/_util.scss | 27 + style/css/catalog_items.css | 152 + style/css/code.css | 79 + style/css/javadoc.scss | 119 + style/css/website.scss | 20 + style/deps/README.md | 3 + .../glyphicons-halflings-regular.eot | Bin 0 -> 20335 bytes .../glyphicons-halflings-regular.svg | 229 + .../glyphicons-halflings-regular.ttf | Bin 0 -> 41280 bytes .../glyphicons-halflings-regular.woff | Bin 0 -> 23320 bytes style/deps/bootstrap-theme.css | 346 + style/deps/bootstrap.css | 5784 +++++++++++ style/deps/bootstrap.js | 1951 ++++ style/deps/bootstrap.min.css | 7 + style/deps/bootstrap.min.js | 6 + style/deps/font-awesome-4.2.0/_LICENSE | 1 + .../font-awesome-4.2.0/css/font-awesome.css | 1672 ++++ .../font-awesome-4.2.0/css/font-awesome.min.css | 4 + .../font-awesome-4.2.0/fonts/FontAwesome.otf | Bin 0 -> 85908 bytes .../fonts/fontawesome-webfont.eot | Bin 0 -> 56006 bytes .../fonts/fontawesome-webfont.svg | 520 + .../fonts/fontawesome-webfont.ttf | Bin 0 -> 112160 bytes .../fonts/fontawesome-webfont.woff | Bin 0 -> 65452 bytes .../less/bordered-pulled.less | 16 + style/deps/font-awesome-4.2.0/less/core.less | 11 + .../font-awesome-4.2.0/less/fixed-width.less | 6 + .../font-awesome-4.2.0/less/font-awesome.less | 17 + style/deps/font-awesome-4.2.0/less/icons.less | 552 ++ style/deps/font-awesome-4.2.0/less/larger.less | 13 + style/deps/font-awesome-4.2.0/less/list.less | 19 + style/deps/font-awesome-4.2.0/less/mixins.less | 25 + style/deps/font-awesome-4.2.0/less/path.less | 14 + .../less/rotated-flipped.less | 20 + .../deps/font-awesome-4.2.0/less/spinning.less | 29 + style/deps/font-awesome-4.2.0/less/stacked.less | 20 + .../deps/font-awesome-4.2.0/less/variables.less | 561 ++ .../scss/_bordered-pulled.scss | 16 + style/deps/font-awesome-4.2.0/scss/_core.scss | 11 + .../font-awesome-4.2.0/scss/_fixed-width.scss | 6 + style/deps/font-awesome-4.2.0/scss/_icons.scss | 552 ++ style/deps/font-awesome-4.2.0/scss/_larger.scss | 13 + style/deps/font-awesome-4.2.0/scss/_list.scss | 19 + style/deps/font-awesome-4.2.0/scss/_mixins.scss | 25 + style/deps/font-awesome-4.2.0/scss/_path.scss | 14 + .../scss/_rotated-flipped.scss | 20 + .../deps/font-awesome-4.2.0/scss/_spinning.scss | 29 + .../deps/font-awesome-4.2.0/scss/_stacked.scss | 20 + .../font-awesome-4.2.0/scss/_variables.scss | 561 ++ .../font-awesome-4.2.0/scss/font-awesome.scss | 17 + style/deps/glossarizer.js | 379 + .../images/ui-bg_flat_0_aaaaaa_40x100.png | Bin 0 -> 180 bytes .../images/ui-bg_flat_75_ffffff_40x100.png | Bin 0 -> 178 bytes .../images/ui-bg_glass_55_fbf9ee_1x400.png | Bin 0 -> 120 bytes .../images/ui-bg_glass_65_ffffff_1x400.png | Bin 0 -> 105 bytes .../images/ui-bg_glass_75_dadada_1x400.png | Bin 0 -> 111 bytes .../images/ui-bg_glass_75_e6e6e6_1x400.png | Bin 0 -> 110 bytes .../images/ui-bg_glass_95_fef1ec_1x400.png | Bin 0 -> 119 bytes .../ui-bg_highlight-soft_75_cccccc_1x100.png | Bin 0 -> 101 bytes .../images/ui-icons_222222_256x240.png | Bin 0 -> 4369 bytes .../images/ui-icons_2e83ff_256x240.png | Bin 0 -> 4369 bytes .../images/ui-icons_454545_256x240.png | Bin 0 -> 4369 bytes .../images/ui-icons_888888_256x240.png | Bin 0 -> 4369 bytes .../images/ui-icons_cd0a0a_256x240.png | Bin 0 -> 4369 bytes .../deps/jquery-ui/jquery-ui-1.8.18.custom.css | 565 ++ .../jquery-ui/jquery-ui-1.8.18.custom.min.js | 356 + style/deps/jquery.cookie.js | 94 + style/deps/jquery.js | 9190 ++++++++++++++++++ style/deps/jquery.min.js | 4 + style/deps/octicons/LICENSE.txt | 9 + style/deps/octicons/README.md | 1 + style/deps/octicons/octicons-local.ttf | Bin 0 -> 52764 bytes style/deps/octicons/octicons.css | 235 + style/deps/octicons/octicons.eot | Bin 0 -> 31440 bytes style/deps/octicons/octicons.less | 233 + style/deps/octicons/octicons.svg | 198 + style/deps/octicons/octicons.ttf | Bin 0 -> 31272 bytes style/deps/octicons/octicons.woff | Bin 0 -> 17492 bytes style/deps/octicons/sprockets-octicons.scss | 230 + style/deps/superfish.js | 121 + style/deps/tooltip.css | 64 + style/deps/tooltip.js | 86 + style/deps/underscore-min.js | 6 + style/deps/underscore-min.map | 1 + style/img/apache-brooklyn-logo-244px-wide.png | Bin 0 -> 4892 bytes style/img/apache-brooklyn-logo-817px-wide.png | Bin 0 -> 10688 bytes style/img/bridge-large-no-title.png | Bin 0 -> 66113 bytes style/img/bridge.png | Bin 0 -> 20450 bytes style/img/brooklyn.gif | Bin 0 -> 4873 bytes style/img/clipboard-green-click.png | Bin 0 -> 51832 bytes style/img/clipboard-green-hover.png | Bin 0 -> 51473 bytes style/img/clipboard-green-normal.png | Bin 0 -> 61853 bytes style/img/clipboard.png | Bin 0 -> 3981 bytes style/img/divider-quicklinks.gif | Bin 0 -> 817 bytes style/img/feather.png | Bin 0 -> 40042 bytes style/img/github-1024-black.png | Bin 0 -> 15613 bytes style/img/github-256-black.png | Bin 0 -> 12166 bytes style/img/github-256-green.png | Bin 0 -> 13875 bytes style/img/irc-256-black.png | Bin 0 -> 4446 bytes style/img/irc-256-green.png | Bin 0 -> 5731 bytes style/img/irc-icon.graffle | 640 ++ style/img/ok.png | Bin 0 -> 595 bytes style/img/twitter-256-black.png | Bin 0 -> 10590 bytes style/img/twitter-256-green.png | Bin 0 -> 11732 bytes style/img/twitter-4096-black.png | Bin 0 -> 45680 bytes style/img/warning.png | Bin 0 -> 29886 bytes style/js/_readme.txt | 2 + style/js/catalog/bloodhound.js | 727 ++ style/js/catalog/common.js | 103 + style/js/underscore-min.js | 6 + style/js/underscore-min.map | 1 + website/community/how-to-contribute-docs.md | 65 + website/community/index.md | 73 + website/community/irc.md | 14 + website/community/mailing-lists.md | 36 + website/developers/code-standards.md | 14 + website/developers/committers/index.md | 11 + .../committers/merging-contributed-code.md | 118 + .../committers/release-process/announce.md | 55 + .../release-process/environment-variables.md | 21 + .../committers/release-process/fix-release.md | 13 + .../committers/release-process/index.md | 30 + .../release-process/make-release-artifacts.md | 58 + .../committers/release-process/prerequisites.md | 136 + .../committers/release-process/publish-temp.md | 41 + .../committers/release-process/publish.md | 160 + .../release-process/release-version.md | 83 + .../release-process/verify-release-artifacts.md | 165 + .../committers/release-process/vote-ipmc.md | 99 + .../committers/release-process/vote.md | 139 + website/developers/fork-after.png | Bin 0 -> 134377 bytes website/developers/fork-before.png | Bin 0 -> 131674 bytes website/developers/fork-new.png | Bin 0 -> 137626 bytes website/developers/how-to-contribute.md | 109 + website/developers/index.md | 46 + website/developers/links.md | 22 + website/developers/pull-request.png | Bin 0 -> 94166 bytes website/documentation/faq.md | 50 + website/documentation/glossary.md | 92 + website/documentation/increase-entropy.md | 31 + website/documentation/index.md | 30 + website/documentation/other-docs.md | 10 + website/download/index.md | 99 + website/download/verify.md | 151 + website/index.md | 77 + website/learnmore/blueprint-tour.md | 191 + website/learnmore/catalog/catalog-item.html | 138 + website/learnmore/catalog/index.html | 161 + .../learnmore/features/blueprint-compose.png | Bin 0 -> 15299 bytes .../features/blueprint-machine-specs.png | Bin 0 -> 16214 bytes website/learnmore/features/blueprinting.md | 24 + website/learnmore/features/index.md | 18 + website/learnmore/features/java-hierarchy.png | Bin 0 -> 106962 bytes website/learnmore/features/java.md | 41 + website/learnmore/features/operations.md | 75 + website/learnmore/features/ops-console.png | Bin 0 -> 491417 bytes website/learnmore/features/ops-rest.png | Bin 0 -> 62894 bytes website/learnmore/features/policy-based-mgmt.md | 28 + website/learnmore/index.md | 30 + website/learnmore/theory.md | 184 + website/meta/license.md | 205 + website/meta/sitemap.md | 25 + website/meta/versions.md | 98 + 953 files changed, 48427 insertions(+), 48925 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/6e86cb02/.gitignore ---------------------------------------------------------------------- diff --git a/.gitignore b/.gitignore index ed439f2..806a062 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,7 @@ brooklyn*.log.* *brooklyn-persisted-state/ ignored +_site +_config_local.yml +.sass-cache +style/js/catalog/items.js http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/6e86cb02/Gemfile ---------------------------------------------------------------------- diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..11d388b --- /dev/null +++ b/Gemfile @@ -0,0 +1,11 @@ +#ruby=ruby-2.1.2 +#ruby-gemset=incubator-brooklyn-site + +source 'https://rubygems.org' +ruby '2.1.2' + +gem 'jekyll' +gem 'therubyracer' +gem 'html-proofer' +gem 'json' + http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/6e86cb02/Gemfile.lock ---------------------------------------------------------------------- diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..f48dc2b --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,98 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.3.6) + blankslate (2.1.2.4) + celluloid (0.16.0) + timers (~> 4.0.0) + classifier-reborn (2.0.3) + fast-stemmer (~> 1.0) + coffee-script (2.3.0) + coffee-script-source + execjs + coffee-script-source (1.8.0) + colorator (0.1) + colored (1.2) + ethon (0.7.2) + ffi (>= 1.3.0) + execjs (2.2.2) + fast-stemmer (1.0.2) + ffi (1.9.6) + hitimes (1.2.2) + html-proofer (1.6.0) + addressable (~> 2.3) + colored (~> 1.2) + mercenary (~> 0.3.2) + nokogiri (~> 1.5) + parallel (~> 1.3) + typhoeus (~> 0.6.7) + yell (~> 2.0) + jekyll (2.5.3) + classifier-reborn (~> 2.0) + colorator (~> 0.1) + jekyll-coffeescript (~> 1.0) + jekyll-gist (~> 1.0) + jekyll-paginate (~> 1.0) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 2.6.1) + mercenary (~> 0.3.3) + pygments.rb (~> 0.6.0) + redcarpet (~> 3.1) + safe_yaml (~> 1.0) + toml (~> 0.1.0) + jekyll-coffeescript (1.0.1) + coffee-script (~> 2.2) + jekyll-gist (1.1.0) + jekyll-paginate (1.1.0) + jekyll-sass-converter (1.3.0) + sass (~> 3.2) + jekyll-watch (1.2.0) + listen (~> 2.7) + json (1.8.2) + kramdown (1.5.0) + libv8 (3.16.14.7) + liquid (2.6.1) + listen (2.8.5) + celluloid (>= 0.15.2) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9) + mercenary (0.3.5) + mini_portile (0.6.2) + nokogiri (1.6.5) + mini_portile (~> 0.6.0) + parallel (1.3.3) + parslet (1.5.0) + blankslate (~> 2.0) + posix-spawn (0.3.9) + pygments.rb (0.6.0) + posix-spawn (~> 0.3.6) + yajl-ruby (~> 1.1.0) + rb-fsevent (0.9.4) + rb-inotify (0.9.5) + ffi (>= 0.5.0) + redcarpet (3.2.2) + ref (1.0.5) + safe_yaml (1.0.4) + sass (3.4.9) + therubyracer (0.12.1) + libv8 (~> 3.16.14.0) + ref + timers (4.0.1) + hitimes + toml (0.1.2) + parslet (~> 1.5.0) + typhoeus (0.6.9) + ethon (>= 0.7.1) + yajl-ruby (1.1.0) + yell (2.0.5) + +PLATFORMS + ruby + +DEPENDENCIES + html-proofer + jekyll + json + therubyracer http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/6e86cb02/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..0ca223f --- /dev/null +++ b/README.md @@ -0,0 +1,289 @@ +Brooklyn Website and Docs Source +================================ + +Contributor Workflow +-------------------- + +The contributor workflow is identical to that used by the main project, with +pull requests and contributor licenses requried. Therefore you should +familiarise yourself with the standard workflow for Apache Brooklyn: + +* [Guide for contributors][CONTRIB] +* [Guide for committers][COMMIT] + +[CONTRIB]: https://brooklyn.apache.org/community/how-to-contribute-docs.html +[COMMIT]: https://brooklyn.apache.org/developers/committers/index.html + + +Workstation Setup +----------------- + +First, if you have not already done so, clone the `incubator-brooklyn` repository +and set up the remotes as described in [Guide for committers][COMMIT]. + +The Brooklyn documentation uses Markdown notation (what this file is written in) +and the Jekyll process. This in turn requires Ruby and gems as described in the `Gemfile`: +install [RVM](http://rvm.io/) to manage Ruby installations and sets of Ruby gems. + + \curl -sSL https://get.rvm.io | bash -s stable + +Close your shell session and start a new one, to get the new +environment that RVM has configured. Change directory to the location where +you checked out your repository and then to the `docs/` subdirectory (where this file is located). + +RVM should detect its configuration inside `Gemfile` and try to configure itself. +Most likely it will report that the required version of Ruby is not installed, +and it will show the command that you need to run to install the correct version. +Follow the instructions it shows. + +Once the correct version of Ruby is installed, change to your home directory +and then change back (`cd ~ ; cd -`). +This will cause RVM to re-load configuration from `Gemfile` with the correct version of Ruby. + +Finally, run this command to install all the required Gems +at the correct versions: + + bundle install + +Any time you need to reset your Ruby environment for `jekyll` to run correctly, +return to the `_build` directory and re-run the above command. + +On some platforms there may be some fiddling required before `jekyll` runs without errors, +but the ecosystem is fairly mature and most problems can be resolved with a bit of googling. +Some issues we've encountered are: + + * on Mac, install xcode and its command-line tools + * if ruby gets confused about versions, + [clean out your gems](http://judykat.com/ken-judy/force-bundler-rebuild-ruby-rails-gemset/) + * if `libxml2` fails, set `bundle config build.nokogiri --use-system-libraries` before the install + (more details [here](http://www.nokogiri.org/tutorials/installing_nokogiri.html)) + * on Ubuntu, `sudo apt-get install libxslt-dev libxml2-dev` + + +Seeing the Website and Docs +--------------------------- + +To build and most of see the documentation, run this command in your `docs` folder: + + jekyll serve + +This will start up a local web server. The URL is printed by Jekyll when the server starts, +e.g. http://localhost:4000/ . The server will continue to run until you press Ctrl+C. +Modified files will be detected and regenerated (but that might take up to 1m). +Add `--no-watch` argument to turn off regeneration, or use `jekyll build` instead +to generate a site in `_site` without a server. + +This does <i>not</i> generate API docs and certain other material; +see the notes on `_build/build.sh` below for that. + + +Project Structure +----------------- + +Note that there are two interlinked micro-sites in this project: + +* `/website`: this contains the main Brooklyn website, including committer instructions, + download instructions, and "learn more" pages; + this content has **only one instance** on the live website, + and as changes are published they replace old content + +* `/guide`: this contains the user guide and information pertaining to a + specific Brooklyn version, including code structure and API documentation; + the live website contains a **copy of the guide for each Brooklyn version**, + with the code coming from the corresponding branch in `git` + +In addition note the following folders: + +* `/style`: contains JS, CSS, and image resources; + on the live website, this folder is installed at the root *and* + into archived versions of the guide. + +* `/_build`: contains build scripts and configuration files, + and tests for some of the plugins + +* `/_plugins`: contains Jekyll plugins which supply tags and generation + logic for the sites, including links and tables of contents + +* `/_layouts`: contains HTML templates used by pages + +* `/_includes`: contains miscellaneous content used by templates and pages + +Jekyll automatically excludes any file or folder beginning with `_` +from direct processing, so these do *not* show up in the `_site` folder +(except where they are embedded in other files). + +**A word on branches:** The `/website` folder can be built against any branch; +typically changes are made and published from `master`, to ensure that all versions +are listed correctly. +In contrast the `/guide` folder should be updated and built against the branch for which +instructions are being made, e.g. `master` for latest snapshot updates, +or `0.7.0-M2` for that milestone release. +It *is* permitted to make changes to docs (and docs only!) after a release has +been made. In most cases, these changes should also be made to master. + + +Website Structure +----------------- + +The two micro-sites above are installed on the live website as follows: + +* `/`: contains the website +* `/v/<version>`: contains specific versions of the guide, + with the special folder `/v/latest` containing the recent preferred stable/milestone version + +The site itself is hosted at `brooklyn.apache.org` with a `CNAME` +record from `brooklyn.io`. + +Content is published to the site by updating an +Apache subversion repository, `incubator-brooklyn-site-public` at +`https://svn.apache.org/repos/asf/incubator/brooklyn/site`. +See below for more information. + + +Building the Website and Guide +------------------------------ + +For most users, the `jekyll serve` command described above is sufficient to test changes locally. +The main reason to use the build scripts (and to read this section) is to push changes to the server +(requires Apache Brooklyn commit rights), or to test generated content such as API docs. + +The build is controlled by config files in `_build/` and accessed through `_build/build.sh`. +There are a number of different builds possible; to list these, run: + + _build/build.sh help + +The normal build outputs to `_site/`. The three builds which are most relevant to updating the live site are: + +* **website-root**: to build the website only, in the root +* **guide-latest**: to build the guide only, in `/v/latest/` +* **guide-version**: to build the guide only, in the versioned namespace e.g. `/v/<version>/` + +There are some others, including `test-both`, which apply slightly different configurations +useful for testing. +Supported options beyond that include `--serve`, to start a web browser serving the content of `_site/`, +and `--skip-javadoc`, to speed up the build significantly by skipping javadoc generation. +A handy command for testing the live files, analogous to `jekyll serve` +but with the correct file structure, and then checking links, is: + + _build/build.sh test-both --skip-javadoc --serve + +And to run link-checks quickly (without validating external links), use: + + htmlproof --href_ignore "https?://127.*" --alt_ignore ".*" --disable_external _site + + + +Preparing for a Release +----------------------- + +When doing a release and changing versions: + +* Before branching: + * Change the `brooklyn-stable-version` variable in `_config.yml` + * Update `website/meta/versions.md` with a bit of info on this release +* In the branch, with `change-version.sh` run (e.g. from `N.SNAPSHOT` to `N`) + * Ensure the `guide/start/release-notes.md` file is current + * Build and publish `website-root`, `guide-latest`, and `guide-version` +* In master, with `change-version.sh` run (e.g. to `N+1-SNAPSHOT`) + * Clear old stuff in the `guide/start/release-notes.md` file + * Optionally build and public `guide-version` + + +Publishing the Website and Guide +-------------------------------- + +The Apache website publication process is based around the Subversion repository; +the generated HTML files must be checked in to Subversion, whereupon an automated process +will publish the files to the live website. +So, to push changes the live site, you will need to have the website directory checked out +from the Apache subversion repository. We recommend setting this up as a sibling to your +`incubator-brooklyn` git project directory: + + # verify we're in the right location and the site does not already exist + ls _build/build.sh || { echo "ERROR: you should be in the docs/ directory to run this command" ; exit 1 ; } + ls ../../incubator-brooklyn-site-public > /dev/null && { echo "ERROR: incubator-brooklyn-site-public dir already exists" ; exit 1 ; } + pushd `pwd -P`/../.. + + svn --non-interactive --trust-server-cert co https://svn.apache.org/repos/asf/incubator/brooklyn/site incubator-brooklyn-site-public + + # verify it + cd incubator-brooklyn-site-public + ls style/img/apache-brooklyn-logo-244px-wide.png || { echo "ERROR: checkout is wrong" ; exit 1 ; } + export BROOKLYN_SITE_DIR=`pwd` + popd + echo "SUCCESS: checked out site in $BROOKLYN_SITE_DIR" + +With this checked out, the `build.sh` script can automatically copy generated files into the right subversion sub-directories +with the `--install` option. (This assumes the relative structure described above; if you have a different +structure, set BROOKLYN_SITE_DIR to point to the directory as above. Alternatively you can copy files manually, +using the instructions in `build.sh` as a guide.) + +A typical update consists of the following commands (or a subset), +copied to `${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}`: + + # ensure svn repo is up-to-date (very painful otherwise) + cd ${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public} + svn up + cd - + + # versioned guide, safe for snapshots, relative to /v/<version>/ + _build/build.sh guide-version --install + + # main website, if desired, relative to / + _build/build.sh website-root --install + + # this version as the latest guide, if desired, relative to /v/latest/ + _build/build.sh guide-latest --install + +(If HTML-Proofer find failures, then fix the links etc. Unfortunately, the javadoc build +gives a lot of warnings. Fixing those is not part of this activity). + +You can then preview the public site of [localhost:4000](http://localhost:4000) with: + + _build/serve-public-site.sh + +Next it is recommended to go to the SVN dir and +review the changes using the usual `svn` commands -- `status`, `diff`, `add`, `rm`, etc. +Note in particular that deleted files need special attention (there is no analogue of +`git add -A`!). Look at deletions carefully, to try to avoid breaking links, but once +you've done that these commands might be useful: + + cd ${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public} + svn add * --force + export DELETIONS=$( svn status | sed -e '/^!/!d' -e 's/^!//' ) + if [ ! -z "${DELETIONS}" ] ; then svn rm ${DELETIONS} ; fi + +Then check in the changes (probably picking a better message than shown here): + + svn ci -m 'Update Brooklyn website' + +The changes should become live within a few minutes. + +SVN commits can be **slow**, particularly if you've regenerated javadoc. +(The date is included in all javadoc files so the commands above will cause *all* javadoc to be updated.) +Use `_build/build.sh guide-version --install --skip-javadoc` to update master while re-using the previously installed javadoc. +That command will fail if javadoc has not been generated for that version. + + +More Notes on the Code +---------------------- + +# Plugins + +We use some custom Jekyll plugins, in the `_plugins` dir: + +* include markdown files inside other files (see, for example, the `*.include.md` files + which contain text which is used in multiple other files) +* generate the site structure / menu objects +* parse JSON which we can loop over in our markdown docs (to build up models; previously used + for the TOC in the guide, but now replaced with site_structure) +* trim whitespace of ends of variables + + +# Versions + +Archived versions are kept under `/v/` in the website. New versions should be added with +the appropriate directory (`_build/build.sh guide-version` above will do this). +These versions take their own copy of the `style` files so that changes there will not affect future versions. + +A list of available versions is in `website/meta/versions.md`. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/6e86cb02/_build/build.sh ---------------------------------------------------------------------- diff --git a/_build/build.sh b/_build/build.sh new file mode 100755 index 0000000..e5d196d --- /dev/null +++ b/_build/build.sh @@ -0,0 +1,309 @@ +#!/usr/bin/env bash +# +# this generates the site in _site +# override --url /myMountPoint (as an argument to this script) if you don't like the default set in /_config.yml + +export JAVADOC_SUBPATH=misc/javadoc +export JAVADOC_BUILD_TARGET_SUBPATH=javadoc + +if [ ! -x _build/build.sh ] ; then + echo ERROR: script must be run in root of docs dir + exit 1 +fi + +function help() { + echo "" + echo "This will build the documentation in _site/." + echo "" + echo "Usage: _build/build.sh MODE [ARGS]" + echo "" + echo "where MODE can be any of:" + echo "* website-root : to build the website only, in the root" + echo "* guide-latest : to build the guide only, in /v/latest/" + # BROOKLYN_VERSION_BELOW + echo "* guide-version : to build the guide only, in the versioned namespace /v/0.9.0-SNAPSHOT/" + echo "* test-guide-root : to build the guide only, in the root (for testing)" + echo "* test-both : to build the website to root and guide to /v/latest/ (for testing)" + echo "* test-both-sub : to build the website to /sub/ and guide to /sub/v/latest/ (for testing)" + echo "* original : to build the files in their original location (website it /website and guide in /guide/, for testing)" + echo "" + echo "and supported ARGS are:" + echo "* --skip-javadoc : to skip javadoc build" + echo "* --quick-javadoc : to do a quick javadoc build (for testing)" + echo "* --serve : serve files from _site after building (for testing)" + echo "* --install : install files from _site to the appropriate place in "'$'"BROOKLYN_SITE_DIR (or ../../incubator-brooklyn-site-public)" + echo "* --skip-htmlproof : skip the HTML Proof run on _site" + echo "* --quick-htmlproof : do a fast HTML Proof run on _site (not checking external links)" + echo "" +} + +function parse_mode() { + case $1 in + help) + help + exit 0 ;; + website-root) + JEKYLL_CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-guide.yml,_build/config-website-root.yml + STYLE_SUBDIR=style + DIRS_TO_MOVE[0]=website + DIRS_TO_MOVE_TARGET[0]="" + SKIP_JAVADOC=true + INSTALL_RSYNC_OPTIONS="--exclude v" + INSTALL_RSYNC_SUBDIR="" + SUMMARY="website files in the root" + HTMLPROOF_OPTS=--ignore-v-refs + ;; + guide-latest) + JEKYLL_CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-all-but-guide.yml,_build/config-guide-latest.yml,_build/config-style-latest.yml + DIRS_TO_MOVE[0]=guide + DIRS_TO_MOVE_TARGET[0]=v/latest + DIRS_TO_MOVE[1]=style + STYLE_SUBDIR=${DIRS_TO_MOVE_TARGET[0]}/style + DIRS_TO_MOVE_TARGET[1]=$STYLE_SUBDIR + INSTALL_RSYNC_OPTIONS="" + INSTALL_RSYNC_SUBDIR=${DIRS_TO_MOVE_TARGET[0]}/ + JAVADOC_TARGET=${DIRS_TO_MOVE_TARGET[0]}/$JAVADOC_SUBPATH/ + SUMMARY="user guide files in /${DIRS_TO_MOVE_TARGET[0]}" + HTMLPROOF_OPTS=--v-only + ;; + guide-version) + JEKYLL_CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-all-but-guide.yml,_build/config-guide-version.yml + # Mac bash defaults to v3 not v4, so can't use assoc arrays :( + DIRS_TO_MOVE[0]=guide + # BROOKLYN_VERSION_BELOW + DIRS_TO_MOVE_TARGET[0]=v/0.9.0-SNAPSHOT + DIRS_TO_MOVE[1]=style + STYLE_SUBDIR=${DIRS_TO_MOVE_TARGET[0]}/style + DIRS_TO_MOVE_TARGET[1]=$STYLE_SUBDIR + INSTALL_RSYNC_OPTIONS="" + INSTALL_RSYNC_SUBDIR=${DIRS_TO_MOVE_TARGET[0]}/ + JAVADOC_TARGET=${DIRS_TO_MOVE_TARGET[0]}/$JAVADOC_SUBPATH/ + SUMMARY="user guide files in /${DIRS_TO_MOVE_TARGET[0]}" + HTMLPROOF_OPTS=--v-only + ;; + test-guide-root) + JEKYLL_CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-all-but-guide.yml,_build/config-guide-root.yml + DIRS_TO_MOVE[0]=guide + DIRS_TO_MOVE_TARGET[0]="" + STYLE_SUBDIR=style + JAVADOC_TARGET=$JAVADOC_SUBPATH/ + SUMMARY="user guide files in the root" + ;; + test-both) + JEKYLL_CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-root-index.yml,_build/config-website-root.yml,_build/config-guide-latest.yml + DIRS_TO_MOVE[0]=guide + DIRS_TO_MOVE_TARGET[0]=v/latest + DIRS_TO_MOVE[1]=website + DIRS_TO_MOVE_TARGET[1]="" + STYLE_SUBDIR=style + JAVADOC_TARGET=${DIRS_TO_MOVE_TARGET[0]}/$JAVADOC_SUBPATH/ + SUMMARY="all files, website in root and guide in /${DIRS_TO_MOVE_TARGET[0]}" + HTMLPROOF_OPTS=--ignore-v-refs + ;; + test-both-sub) + JEKYLL_CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-root-index.yml,_build/config-subpath-brooklyn.yml + DIRS_TO_MOVE[0]=guide + DIRS_TO_MOVE_TARGET[0]=brooklyn/v/latest + DIRS_TO_MOVE[1]=website + DIRS_TO_MOVE_TARGET[1]=brooklyn + DIRS_TO_MOVE[2]=style + STYLE_SUBDIR=${DIRS_TO_MOVE_TARGET[1]}/style + DIRS_TO_MOVE_TARGET[2]=$STYLE_SUBDIR + JAVADOC_TARGET=${DIRS_TO_MOVE_TARGET[0]}/$JAVADOC_SUBPATH/ + SUMMARY="all files in /brooklyn" + HTMLPROOF_OPTS=--ignore-v-refs + ;; + original) + JEKYLL_CONFIG=_config.yml,_build/config-production.yml + STYLE_SUBDIR=style + SUMMARY="all files in their original place" + HTMLPROOF_OPTS=--ignore-v-refs + ;; + "") + echo "ERROR: mode is required; try 'help'" + exit 1 ;; + *) + echo "ERROR: invalid mode '$1'; try 'help'" + exit 1 ;; + esac + SUMMARY="$SUMMARY of `pwd`/_site" +} + +function parse_arguments() { + while (( "$#" )); do + case $1 in + "--skip-javadoc") + SKIP_JAVADOC=true + shift + ;; + "--quick-javadoc") + QUICK_JAVADOC=true + shift + ;; + "--serve") + SERVE_AFTERWARDS=true + shift + ;; + "--install") + INSTALL_AFTERWARDS=true + shift + ;; + "--skip-htmlproof") + SKIP_HTMLPROOF=true + shift + ;; + "--quick-htmlproof") + QUICK_HTMLPROOF=true + shift + ;; + *) + echo "ERROR: invalid argument '"$1"'" + exit 1 + ;; + esac + done +} + +# Runs htmlproof against _site +function test_site() { + if [ "$SKIP_HTMLPROOF" == "true" ]; then + return + fi + echo "Running htmlproof on _site" + mkdir -p _build/target + HTMLPROOF_LOG="_build/target/htmlproof.log" + if [ "$QUICK_HTMLPROOF" == "true" ]; then + HTMLPROOF_OPTS="$HTMLPROOF_OPTS --disable_external" + fi + _build/htmlproof-brooklyn.sh $HTMLPROOF_OPTS 2>&1 | tee $HTMLPROOF_LOG +} + +function make_jekyll() { + BROOKLYN_BIN=../usage/dist/target/brooklyn-dist/brooklyn/bin/brooklyn + if [ -f $BROOKLYN_BIN ]; then + ITEMS_JS=style/js/catalog/items.js + echo "Generating catalog items in $ITEMS_JS" + echo -n "var items = " > "$ITEMS_JS" + JAVA_OPTS='-Dlogback.configurationFile=_build/list-objects-logback.xml' $BROOKLYN_BIN \ + list-objects >> "$ITEMS_JS" + echo ";" >> "$ITEMS_JS" + echo "Generating catalog items completed" + fi + + echo JEKYLL running with: jekyll build $JEKYLL_CONFIG + jekyll build --config $JEKYLL_CONFIG || return 1 + echo JEKYLL completed + + for DI in "${!DIRS_TO_MOVE[@]}"; do + D=${DIRS_TO_MOVE[$DI]} + DT=${DIRS_TO_MOVE_TARGET[$DI]} + echo moving _site/$D/ to _site/$DT + mkdir -p _site/$DT + # the generated files are already in _site/ due to url rewrites along the way, but images etc are not + cp -r _site/$D/* _site/$DT + rm -rf _site/$D + done + # normally we exclude things but we can also set TARGET as long_grass and it will get destroyed + rm -rf _site/long_grass +} + +function make_javadoc() { + if [ "$SKIP_JAVADOC" == "true" ]; then + return + fi + pushd _build > /dev/null + rm -rf target/$JAVADOC_BUILD_TARGET_SUBPATH + if [ "$QUICK_JAVADOC" == "true" ]; then + ./quick-make-few-javadoc.sh || { echo ERROR: failed javadoc build ; exit 1 ; } + else + ./make-javadoc.sh || { echo ERROR: failed javadoc build ; exit 1 ; } + fi + popd > /dev/null + if [ ! -z "$JAVADOC_TARGET" ]; then + if [ ! -d "_site/$JAVADOC_TARGET" ]; then + echo "ERROR: javadoc target directory _site/$JAVADOC_TARGET gone; is there a jekyll already watching?" + return 1 + fi + mv _build/target/$JAVADOC_BUILD_TARGET_SUBPATH/* _site/$JAVADOC_TARGET + cat _site/${STYLE_SUBDIR}/css/javadoc.css >> _site/$JAVADOC_TARGET/stylesheet.css || return 1 + cp _site/${STYLE_SUBDIR}/img/feather.png _site/$JAVADOC_TARGET/ || return 1 + fi +} + +function make_install() { + if [ "$INSTALL_AFTERWARDS" != "true" ]; then + return + fi + if [ -d _site/website ]; then + echo "ERROR: _site/website dir exists, not installing as files may be corrupted; is there a jekyll already watching?" + return 1 + fi + if [ -d _site/guide ]; then + echo "ERROR: _site/guide dir exists, not installing as files may be corrupted; is there a jekyll already watching?" + return 1 + fi + if [ ! -z ${QUICK_JAVADOC+SET} ]; then echo "ERROR: --install not permitted when doing quick javadoc" ; return 1 ; fi + + SITE_DIR=${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public} + ls $SITE_DIR/style/img/apache-brooklyn-logo-244px-wide.png > /dev/null || { echo "ERROR: cannot find incubator-brooklyn-site-public; set BROOKLYN_SITE_DIR" ; return 1 ; } + if [ -z ${INSTALL_RSYNC_OPTIONS+SET} ]; then echo "ERROR: --install not supported for this build" ; return 1 ; fi + if [ -z ${INSTALL_RSYNC_SUBDIR+SET} ]; then echo "ERROR: --install not supported for this build" ; return 1 ; fi + + RSYNC_COMMAND_BASE="rsync -rvi --delete --exclude .svn" + + if [ ! -z ${JAVADOC_TARGET+SET} ]; then + if [ ! -z ${SKIP_JAVADOC+SET} ]; then + echo 'grep "Generated by javadoc" '$SITE_DIR/$INSTALL_RSYNC_SUBDIR/$JAVADOC_SUBPATH/index.html + export JAVADOC_LAST_DATE=`grep "Generated by javadoc" $SITE_DIR/$INSTALL_RSYNC_SUBDIR/$JAVADOC_SUBPATH/index.html` + if [ -z "$JAVADOC_LAST_DATE" ]; then + echo "ERROR: installing with skipped javadoc, but no previous javadoc exists" + return 1 + fi + echo "Installing with skipped javadoc, reusing old: $JAVADOC_LAST_DATE" + RSYNC_COMMAND_BASE="$RSYNC_COMMAND_BASE --exclude $JAVADOC_SUBPATH" + fi + fi + + RSYNC_COMMAND="$RSYNC_COMMAND_BASE $INSTALL_RSYNC_OPTIONS ./_site/$INSTALL_RSYNC_SUBDIR $SITE_DIR/$INSTALL_RSYNC_SUBDIR" + echo INSTALLING to local site svn repo with: $RSYNC_COMMAND + $RSYNC_COMMAND | tee _build/target/rsync.log || return 1 + + echo RSYNC changed files: + grep -v f\\.\\.T\\.\\.\\.\\.\\.\\.\\. _build/target/rsync.log || echo "(none)" + echo + + if [ ! -z "$HTMLPROOF_LOG" ]; then + echo HTMLPROOF log: + cat $HTMLPROOF_LOG + echo + fi + + SUMMARY="$SUMMARY, installed to $SITE_DIR" +} + + +rm -rf _site + +parse_mode $@ +shift +parse_arguments $@ + +make_jekyll || { echo ERROR: failed jekyll docs build in `pwd` ; exit 1 ; } + +make_javadoc || { echo ERROR: failed javadoc build ; exit 1 ; } + +test_site + +# TODO build catalog + +# TODO install + +if [ "$INSTALL_AFTERWARDS" == "true" ]; then + make_install || { echo ERROR: failed to install ; exit 1 ; } +fi + +echo FINISHED: $SUMMARY + +if [ "$SERVE_AFTERWARDS" == "true" ]; then + _build/serve-site.sh +fi http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/6e86cb02/_build/config-exclude-all-but-guide.yml ---------------------------------------------------------------------- diff --git a/_build/config-exclude-all-but-guide.yml b/_build/config-exclude-all-but-guide.yml new file mode 100644 index 0000000..08e4d78 --- /dev/null +++ b/_build/config-exclude-all-but-guide.yml @@ -0,0 +1 @@ +exclude: ['/Gemfile*','/README.md','/index.md','/website/'] http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/6e86cb02/_build/config-exclude-guide.yml ---------------------------------------------------------------------- diff --git a/_build/config-exclude-guide.yml b/_build/config-exclude-guide.yml new file mode 100644 index 0000000..984cd5d --- /dev/null +++ b/_build/config-exclude-guide.yml @@ -0,0 +1 @@ +exclude: ['/Gemfile*','/README.md','/index.md','/guide/'] http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/6e86cb02/_build/config-exclude-root-index.yml ---------------------------------------------------------------------- diff --git a/_build/config-exclude-root-index.yml b/_build/config-exclude-root-index.yml new file mode 100644 index 0000000..6eba321 --- /dev/null +++ b/_build/config-exclude-root-index.yml @@ -0,0 +1 @@ +exclude: ['/Gemfile*','/README.md','/index.md'] http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/6e86cb02/_build/config-guide-latest.yml ---------------------------------------------------------------------- diff --git a/_build/config-guide-latest.yml b/_build/config-guide-latest.yml new file mode 100644 index 0000000..faf2631 --- /dev/null +++ b/_build/config-guide-latest.yml @@ -0,0 +1,3 @@ +path: + guide: /v/latest + website: ""
