Add partial-summary plugin which adds back contextual summary
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/7ca72e7e Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/7ca72e7e Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/7ca72e7e Branch: refs/heads/master Commit: 7ca72e7e4975c9d3dc2dfd028804491293efbc32 Parents: e3063df Author: Thomas Bouron <[email protected]> Authored: Fri Oct 13 11:51:00 2017 +0100 Committer: Thomas Bouron <[email protected]> Committed: Mon Oct 16 14:56:48 2017 +0100 ---------------------------------------------------------------------- book.json | 6 +++++- guide/SUMMARY.md | 15 +++++++-------- guide/blueprints/ansible/index.md | 4 +--- guide/blueprints/catalog/index.md | 10 +--------- guide/blueprints/chef/index.md | 6 +----- guide/blueprints/index.md | 27 ++------------------------- guide/blueprints/java/index.md | 12 +----------- guide/blueprints/salt/index.md | 4 +--- guide/blueprints/test/index.md | 4 +--- guide/blueprints/winrm/index.md | 2 -- guide/concepts/index.md | 11 +---------- guide/dev/index.md | 13 +------------ guide/locations/index.md | 3 --- guide/misc/index.md | 9 ++------- guide/ops/cli/cli-ref-guide.md | 13 ------------- guide/ops/cli/cli-usage-guide.md | 9 --------- guide/ops/cli/index.md | 4 +--- guide/ops/configuration/brooklyn_cfg.md | 7 ------- guide/ops/configuration/index.md | 7 +------ guide/ops/gui/blueprints.md | 3 --- guide/ops/gui/index.md | 9 ++------- guide/ops/high-availability/index.md | 2 -- guide/ops/index.md | 20 ++------------------ guide/ops/persistence/index.md | 7 ------- guide/ops/troubleshooting/index.md | 16 ++-------------- guide/start/index.md | 12 ++---------- guide/start/managing.md | 8 -------- package-lock.json | 6 ++++++ package.json | 1 + 29 files changed, 41 insertions(+), 209 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/book.json ---------------------------------------------------------------------- diff --git a/book.json b/book.json index be0f84d..76b6cfb 100644 --- a/book.json +++ b/book.json @@ -7,13 +7,17 @@ "collapsible-chapters", "bootstrap-callout", "styles-less", - "versions" + "versions", + "partial-summary" ], "styles": { "website": "./styles/website.less", "pdf": "./styles/pdf.less" }, "pluginsConfig": { + "partial-summary": { + "depth": 0 + }, "include-highlight": { "extensionToLanguage": { "yml": "yaml", http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/SUMMARY.md ---------------------------------------------------------------------- diff --git a/guide/SUMMARY.md b/guide/SUMMARY.md index 54d0377..fb80066 100644 --- a/guide/SUMMARY.md +++ b/guide/SUMMARY.md @@ -2,7 +2,7 @@ ### User Guide -* Getting Started +* [Getting Started](start/index.md) * [Running Apache Brooklyn](start/running.md) * [Deploying Blueprints](start/blueprints.md) * [Monitoring and Managing Applications](start/managing.md) @@ -19,7 +19,7 @@ * [Policies](concepts/policies.md) * [Execution](concepts/execution.md) * [Stop/start/restart behaviour](concepts/stop-start-restart-behaviour.md) -* Writing Blueprints +* [Writing Blueprints](blueprints/index.md) * [Creating YAML Blueprint](blueprints/creating-yaml.md) * [Entity Configuration](blueprints/entity-configuration.md) * [Setting Locations](blueprints/setting-locations.md) @@ -85,14 +85,14 @@ * [Location Customizers](locations/index.md#location-customizers) * [Customizing Cloud Security Groups](locations/index.md#customizing-cloud-security-groups) * [Specialized Locations](locations/index.md#specialized-locations) -* Reference Guide +* [Reference Guide](ops/index.md) * [Production Installation](ops/production-installation.md) * [Starting, Stopping and Monitoring](ops/starting-stopping-monitoring.md) * [Server CLI Reference](ops/server-cli-reference.md) * [Client CLI Reference](ops/cli/index.md) * [CLI Reference Guide](ops/cli/cli-ref-guide.md) * [CLI Usage Guide](ops/cli/cli-usage-guide.md) - * GUI Guide + * [GUI Guide](ops/gui/index.md) * [Launching](ops/gui/running.md) * [Deploying Blueprints](ops/gui/blueprints.md) * [Monitoring and Managing Applications](ops/gui/managing.md) @@ -112,7 +112,7 @@ * [Requirements](ops/requirements.md) * [Upgrade](ops/upgrade.md) * [Security Guidelines](ops/security-guidelines.md) - * Troubleshooting + * [Troubleshooting](ops/troubleshooting/index.md) * [Overview](ops/troubleshooting/overview.md) * [Web Console Issues](ops/troubleshooting/web-console-issues.md) * [Deployment](ops/troubleshooting/deployment.md) @@ -124,8 +124,8 @@ * [SoftwareProcess Entities](ops/troubleshooting/softwareprocess.md) * [Going Deep in Java and Logs](ops/troubleshooting/going-deep-in-java-and-logs.md) * [Monitoring Memory Usage](ops/troubleshooting/memory-usage.md) -* Other 0.12.0 Resources - * [Glossary](https://brooklyn.apache.org/documentation/glossary.html) +* [Other 0.12.0 Resources](misc/index.md) + * [Glossary](GLOSSARY.md) * [Versions](https://brooklyn.apache.org/meta/versions.html) * [Release Notes](misc/release-notes.md) @@ -145,5 +145,4 @@ ---- -* [Versions](https://brooklyn.apache.org/meta/versions.html) * [Other Resources](https://brooklyn.apache.org/documentation/other-docs.html) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/blueprints/ansible/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/ansible/index.md b/guide/blueprints/ansible/index.md index e992667..a0dd5e4 100644 --- a/guide/blueprints/ansible/index.md +++ b/guide/blueprints/ansible/index.md @@ -1,8 +1,6 @@ --- title: Ansible in YAML Blueprints -children: -- about-ansible.md -- creating-ansible-blueprints.md +partial-summary-depth: 1 --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/blueprints/catalog/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/catalog/index.md b/guide/blueprints/catalog/index.md index 026a0e8..a71f2b5 100644 --- a/guide/blueprints/catalog/index.md +++ b/guide/blueprints/catalog/index.md @@ -1,14 +1,6 @@ --- title: Catalog -children: -- schema.md -- templates.md -- versioning.md -- management.md -- bundle.md -- cli.md - - +partial-summary-depth: 1 --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/blueprints/chef/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/chef/index.md b/guide/blueprints/chef/index.md index cd63b47..b8e7048 100644 --- a/guide/blueprints/chef/index.md +++ b/guide/blueprints/chef/index.md @@ -1,10 +1,6 @@ --- title: Chef in YAML Blueprints -children: -- about-chef.md -- creating-blueprints.md -- writing-chef.md -- advanced-chef-integration.md +partial-summary-depth: 1 --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/blueprints/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/index.md b/guide/blueprints/index.md index 8527617..943d0c8 100644 --- a/guide/blueprints/index.md +++ b/guide/blueprints/index.md @@ -1,28 +1,5 @@ --- title: Writing Blueprints -children: -- creating-yaml.md -- entity-configuration.md -- setting-locations.md -- configuring-vms.md -- multiple-services.md -- custom-entities.md -- catalog/ -- clusters.md -- enrichers.md -- policies.md -- effectors.md -- clusters-and-policies.md -- java/ -- winrm/ -- test/ -- ansible/ -- chef/ -- salt/ -- advanced-example.md -- blueprinting-tips.md -- { path: yaml-reference.md, title: YAML Blueprint Reference } +partial-summary-depth: 1 --- - - - +# {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/blueprints/java/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/index.md b/guide/blueprints/java/index.md index 66a66bc..dd56855 100644 --- a/guide/blueprints/java/index.md +++ b/guide/blueprints/java/index.md @@ -1,16 +1,6 @@ --- title: Java Entities -children: -- archetype.md -- defining-and-deploying.md -- bundle-dependencies.md -- topology-dependencies.md -- common-usage.md -- feeds.md -- entity.md -- entities.md -- service-state.md -- entitlements.md +partial-summary-depth: 1 --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/blueprints/salt/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/salt/index.md b/guide/blueprints/salt/index.md index c6989cc..c244960 100644 --- a/guide/blueprints/salt/index.md +++ b/guide/blueprints/salt/index.md @@ -1,8 +1,6 @@ --- title: Salt in YAML Blueprints -children: -- about-salt.md -- creating-salt-blueprints.md +partial-summary-depth: 1 --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/blueprints/test/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/test/index.md b/guide/blueprints/test/index.md index 0264b52..84a3575 100644 --- a/guide/blueprints/test/index.md +++ b/guide/blueprints/test/index.md @@ -1,8 +1,6 @@ --- title: Testing YAML Blueprints -children: -- test-entities.md -- usage-examples.md +partial-summary-depth: 1 --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/blueprints/winrm/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/winrm/index.md b/guide/blueprints/winrm/index.md index e21ab0c..d6d98f3 100644 --- a/guide/blueprints/winrm/index.md +++ b/guide/blueprints/winrm/index.md @@ -1,7 +1,5 @@ --- title: Windows Blueprints -children: -- client.md --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/concepts/index.md ---------------------------------------------------------------------- diff --git a/guide/concepts/index.md b/guide/concepts/index.md index e004468..ef96eff 100644 --- a/guide/concepts/index.md +++ b/guide/concepts/index.md @@ -1,15 +1,6 @@ --- title: Brooklyn Concepts -children: -- entities.md -- application-parent-membership.md -- configuration-sensor-effectors.md -- lifecycle-managementcontext.md -- dependent-configuration.md -- location.md -- policies.md -- execution.md -- stop-start-restart-behaviour.md +partial-summary-depth: 1 --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/dev/index.md ---------------------------------------------------------------------- diff --git a/guide/dev/index.md b/guide/dev/index.md index fc1adde..eea20cb 100644 --- a/guide/dev/index.md +++ b/guide/dev/index.md @@ -1,17 +1,6 @@ --- title: Developer Guide -children: -- { link: "{{ book.url.brooklyn_website }}/developers/code/", title: "Get the Code" } -- env/maven-build.md -- env/ide/ -- code/structure.md -- code/tests.md -- code/licensing.md -- tips/ -- tips/logging.md -- tips/debugging-remote-brooklyn.md -- { link: "http://github.com/apache/brooklyn";, title: "GitHub" } -- { link: "https://brooklyn.apache.org/v/latest/misc/javadoc";, title: "Javadoc" } +partial-summary-depth: 1 --- {% comment %} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/locations/index.md ---------------------------------------------------------------------- diff --git a/guide/locations/index.md b/guide/locations/index.md index 0c333f3..2c966c7 100644 --- a/guide/locations/index.md +++ b/guide/locations/index.md @@ -1,8 +1,5 @@ --- title: Locations -children: -- { path: provisioned-machine-requirements.md, section_position: 8 } -check_directory_for_children: true --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/misc/index.md ---------------------------------------------------------------------- diff --git a/guide/misc/index.md b/guide/misc/index.md index bf5aa10..7b1e7d8 100644 --- a/guide/misc/index.md +++ b/guide/misc/index.md @@ -1,13 +1,8 @@ --- title: Other Resources -children: -- { title: Javadoc, path: javadoc/ } -- download.md -- release-notes.md -- known-issues.md -- { path: ../dev/, title_in_menu: "Developer Guide" } -- { path: /website/documentation/, title_in_menu: "All Documentation", menu_customization: { force_inactive: true } } +partial-summary-depth: 1 --- +# {{ page.title }} {% if output.name == 'website' %} Further documentation specific to this version of Brooklyn includes: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/cli/cli-ref-guide.md ---------------------------------------------------------------------- diff --git a/guide/ops/cli/cli-ref-guide.md b/guide/ops/cli/cli-ref-guide.md index 57eafb4..30e6b69 100644 --- a/guide/ops/cli/cli-ref-guide.md +++ b/guide/ops/cli/cli-ref-guide.md @@ -1,18 +1,5 @@ --- title: CLI Reference Guide -children: -- { section: List of Commands } -- { section: Scopes } -- { section: Abbreviations} -- { section: Command Reference } -- { section: Login} -- { section: Applications} -- { section: Entities} -- { section: Sensors} -- { section: Effectors} -- { section: Policies} -- { section: Activities} -- { section: Miscellaneous} --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/cli/cli-usage-guide.md ---------------------------------------------------------------------- diff --git a/guide/ops/cli/cli-usage-guide.md b/guide/ops/cli/cli-usage-guide.md index fcaf229..443c910 100644 --- a/guide/ops/cli/cli-usage-guide.md +++ b/guide/ops/cli/cli-usage-guide.md @@ -1,14 +1,5 @@ --- title: CLI Usage Guide -children: -- { section: Login } -- { section: Applications } -- { section: Entities } -- { section: Sensors } -- { section: Effectors } -- { section: Policies } -- { section: Activities } -- { section: YAML Blueprint } --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/cli/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/cli/index.md b/guide/ops/cli/index.md index c9a0ea0..23a05db 100644 --- a/guide/ops/cli/index.md +++ b/guide/ops/cli/index.md @@ -1,8 +1,6 @@ --- title: Client CLI Reference -children: -- cli-ref-guide.md -- cli-usage-guide.md +partial-summary-depth: 1 --- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/configuration/brooklyn_cfg.md ---------------------------------------------------------------------- diff --git a/guide/ops/configuration/brooklyn_cfg.md b/guide/ops/configuration/brooklyn_cfg.md index e40482b..d270098 100644 --- a/guide/ops/configuration/brooklyn_cfg.md +++ b/guide/ops/configuration/brooklyn_cfg.md @@ -1,12 +1,5 @@ --- title: brooklyn.cfg -children: -- { section: Quick Setup } -- { section: Locations } -- { section: Java } -- { section: Authentication } -- { section: Entitlements } -- { section: HTTPS Configuration } --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/configuration/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/configuration/index.md b/guide/ops/configuration/index.md index 2f77b9e..e718fb2 100644 --- a/guide/ops/configuration/index.md +++ b/guide/ops/configuration/index.md @@ -1,11 +1,6 @@ --- title: Brooklyn Configuration and Options -children: -- { section: Memory Usage } -- { section: Authentication } -- brooklyn_cfg.md -- https.md -- cors.md +partial-summary-depth: 1 --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/gui/blueprints.md ---------------------------------------------------------------------- diff --git a/guide/ops/gui/blueprints.md b/guide/ops/gui/blueprints.md index 14486db..e99dca6 100644 --- a/guide/ops/gui/blueprints.md +++ b/guide/ops/gui/blueprints.md @@ -1,8 +1,5 @@ --- title: Deploying Blueprints -children: -- { section: Launching from a Blueprint, title: Launching from a Blueprint } -- { section: Launching from the Catalog, title: Launching from the Catalog } --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/gui/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/gui/index.md b/guide/ops/gui/index.md index 36f11d0..4e130f4 100644 --- a/guide/ops/gui/index.md +++ b/guide/ops/gui/index.md @@ -1,10 +1,5 @@ --- title: GUI Guide -children: -- running.md -- blueprints.md -- managing.md -- policies.md +partial-summary-depth: 1 --- - - +# {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/high-availability/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/high-availability/index.md b/guide/ops/high-availability/index.md index 35b092e..dbf4ffb 100644 --- a/guide/ops/high-availability/index.md +++ b/guide/ops/high-availability/index.md @@ -1,7 +1,5 @@ --- title: High Availability -children: -- high-availability-supplemental.md --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/index.md b/guide/ops/index.md index f4e1be4..eac1fd3 100644 --- a/guide/ops/index.md +++ b/guide/ops/index.md @@ -1,21 +1,5 @@ --- title: Reference Guide -children: -- production-installation.md -- starting-stopping-monitoring.md -- server-cli-reference.md -- cli/ -- gui/ -- rest.md -- configuration/ -- persistence/ -- high-availability/ -- logging.md -- externalized-configuration.md -- requirements.md -- upgrade.md -- security-guidelines.md -- troubleshooting/ +partial-summary-depth: 1 --- - - +# {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/persistence/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/persistence/index.md b/guide/ops/persistence/index.md index c4c1635..5b6133f 100644 --- a/guide/ops/persistence/index.md +++ b/guide/ops/persistence/index.md @@ -1,12 +1,5 @@ --- title: Persistence -children: -- { section: Configuration } -- { section: File-based Persistence } -- { section: Object Store Persistence } -- { section: Rebinding to State } -- { section: Writing Persistable Code } -- { section: Persisted State Backup } --- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/ops/troubleshooting/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/troubleshooting/index.md b/guide/ops/troubleshooting/index.md index 07b6218..72693ea 100644 --- a/guide/ops/troubleshooting/index.md +++ b/guide/ops/troubleshooting/index.md @@ -1,17 +1,5 @@ --- title: Troubleshooting -children: -- { path: overview.md, title: Overview } -- { path: web-console-issues.md, title: Web Console Issues } -- { path: deployment.md, title: Deployment } -- { path: connectivity.md, title: Server Connectivity } -- { path: slow-unresponsive.md, title: Brooklyn Slow or Unresponsive } -- { path: increase-entropy.md, title: Increase Entropy } -- { path: increase-system-resource-limits.md, title: Increase System Resource Limits } -- { path: detailed-support-report.md, title: Detailed Support Report } -- { path: softwareprocess.md, title: SoftwareProcess Entities } -- { path: going-deep-in-java-and-logs.md, title: Going Deep in Java and Logs } -- { path: memory-usage.md, title: Monitoring Memory Usage } +partial-summary-depth: 1 --- - - +# {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/start/index.md ---------------------------------------------------------------------- diff --git a/guide/start/index.md b/guide/start/index.md index e0dc0e8..9d524cd 100644 --- a/guide/start/index.md +++ b/guide/start/index.md @@ -1,13 +1,5 @@ --- title: Getting Started -children: -- running.md -- blueprints.md -- managing.md -- policies.md -- concept-quickstart.md +partial-summary-depth: 1 --- - - - - +# {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/guide/start/managing.md ---------------------------------------------------------------------- diff --git a/guide/start/managing.md b/guide/start/managing.md index e44353e..c0fed8c 100644 --- a/guide/start/managing.md +++ b/guide/start/managing.md @@ -1,11 +1,3 @@ ---- -children: -- { section: Applications } -- { section: Entities } -- { section: Sensors } -- { section: Effectors } -- { section: Activities } ---- # {{ page.title }} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/package-lock.json ---------------------------------------------------------------------- diff --git a/package-lock.json b/package-lock.json index fb19c00..4945de5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -519,6 +519,12 @@ "q": "1.5.0" } }, + "gitbook-plugin-partial-summary": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/gitbook-plugin-partial-summary/-/gitbook-plugin-partial-summary-1.0.0.tgz";, + "integrity": "sha512-SeToSfNToP6XQxntE0Z4Qq7T1NbpbQVJsywr2dobL450I3FXpvs2QgiMyMD+R1Anmys037liry3tk19NHQP0QA==", + "dev": true + }, "gitbook-plugin-search": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/gitbook-plugin-search/-/gitbook-plugin-search-2.2.1.tgz";, http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/7ca72e7e/package.json ---------------------------------------------------------------------- diff --git a/package.json b/package.json index 5b57d04..bbc2f63 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,7 @@ "gitbook-plugin-bootstrap-callout": "^0.1.2", "gitbook-plugin-collapsible-chapters": "^0.1.8", "gitbook-plugin-include-highlight": "^0.2.1", + "gitbook-plugin-partial-summary": "^1.0.0", "gitbook-plugin-styles-less": "^1.0.0", "gitbook-plugin-theme-api": "^1.1.2", "gitbook-plugin-versions": "^2.1.4"
