From 62a9110160355d05ec807ce8d1d278290e6d641f Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Fri, 4 Nov 2016 08:23:03 +0100 Subject: [PATCH] Fix documentation indentation levels. Fixes gh-12. --- src/main/asciidoc/index.adoc | 2 -- src/main/asciidoc/preface.adoc | 20 ++++++++++++++++++- src/main/asciidoc/reference/dependencies.adoc | 2 +- .../asciidoc/reference/getting-started.adoc | 2 +- src/main/asciidoc/reference/introduction.adoc | 16 --------------- 5 files changed, 21 insertions(+), 21 deletions(-) delete mode 100644 src/main/asciidoc/reference/introduction.adoc diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc index 8e5262a2..0fae769e 100644 --- a/src/main/asciidoc/index.adoc +++ b/src/main/asciidoc/index.adoc @@ -19,8 +19,6 @@ ifndef::ebook-format[= Reference documentation [[reference-documentation]]] :leveloffset: +1 -include::reference/introduction.adoc[] - include::reference/vault.adoc[] :leveloffset: -1 diff --git a/src/main/asciidoc/preface.adoc b/src/main/asciidoc/preface.adoc index 826f10bf..cf240fc3 100644 --- a/src/main/asciidoc/preface.adoc +++ b/src/main/asciidoc/preface.adoc @@ -5,7 +5,18 @@ The Spring Vault project applies core Spring concepts to the development of solu This document is the reference guide for Spring Vault. It explains Vault concepts and semantics and the syntax. -This section provides some basic introduction to Spring and Vault. The rest of the document refers only to Spring Vault features and assumes the user is familiar with HashiCorp Vault as well as Spring concepts. +This part of the reference documentation explains the core functionality offered by Spring Vault. + +<> introduces the Vault module feature set. + +== Document Structure + +This section provides basic introduction to Spring and Vault. +It contains details about following development and how to get support. + +The rest of the document refers to Spring Vault features and assumes +the user is familiar with https://www.vaultproject.io[HashiCorp Vault] +as well as Spring concepts. [[get-started:first-steps:spring]] == Knowing Spring @@ -31,6 +42,13 @@ The jumping off ground for learning about Vault is https://www.vaultproject.io[w * https://www.vaultproject.io/docs/index.html[HashiCorp Vault Documentation] +Spring Vault provides client-side support for accessing, storing and revoking secrets. +With https://www.vaultproject.io[HashiCorp's Vault] you have a central place to +manage external secret data for applications across all environments. +Vault can manage static and dynamic secrets such as application data, +username/password for remote applications/resources and provide credentials +for external services such as MySQL, PostgreSQL, Apache Cassandra, Consul, AWS and more. + [[requirements]] == Requirements diff --git a/src/main/asciidoc/reference/dependencies.adoc b/src/main/asciidoc/reference/dependencies.adoc index 81828b2e..20156616 100644 --- a/src/main/asciidoc/reference/dependencies.adoc +++ b/src/main/asciidoc/reference/dependencies.adoc @@ -48,7 +48,7 @@ pattern: `$\{version\}-$\{release\}` where release can be one of the following: ==== [[dependencies.spring-framework]] -=== Spring Framework +== Spring Framework The current version of Spring Vault requires Spring Framework in version {springVersion} or better. The modules might also work with an older bugfix diff --git a/src/main/asciidoc/reference/getting-started.adoc b/src/main/asciidoc/reference/getting-started.adoc index ec6c0624..ed60a844 100644 --- a/src/main/asciidoc/reference/getting-started.adoc +++ b/src/main/asciidoc/reference/getting-started.adoc @@ -1,5 +1,5 @@ [[vault.core.getting-started]] -=== Getting Started += Getting Started Spring Vault support requires Vault 0.5 or higher and Java SE 6 or higher. An easy way to bootstrap setting up a working environment is to create a diff --git a/src/main/asciidoc/reference/introduction.adoc b/src/main/asciidoc/reference/introduction.adoc deleted file mode 100644 index 601f7bd8..00000000 --- a/src/main/asciidoc/reference/introduction.adoc +++ /dev/null @@ -1,16 +0,0 @@ - -[[introduction]] -= Introduction - -== Document Structure - -This part of the reference documentation explains the core functionality offered by Spring Vault. - -<> introduces the Vault module feature set. - -Spring Vault provides client-side support for accessing, storing and revoking secrets. -With https://www.vaultproject.io[HashiCorp's Vault] you have a central place to -manage external secret data for applications across all environments. -Vault can manage static and dynamic secrets such as application data, -username/password for remote applications/resources and provide credentials -for external services such as MySQL, PostgreSQL, Apache Cassandra, Consul, AWS and more.