From 031175421eff3b7c0303884cc4f5460f6125668f Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Thu, 19 Sep 2019 09:32:35 -0400 Subject: [PATCH 1/4] Create "current" stack version file This file will be useful for books that *generally* want to point the current release of the stack. We'll update it when we release a new version of the stack. --- shared/versions/stack/README | 29 ++++++++++++++++++++++++++ shared/versions/stack/current.asciidoc | 1 + 2 files changed, 30 insertions(+) create mode 100644 shared/versions/stack/README create mode 100644 shared/versions/stack/current.asciidoc diff --git a/shared/versions/stack/README b/shared/versions/stack/README new file mode 100644 index 0000000000000..40c0f41eda5e9 --- /dev/null +++ b/shared/versions/stack/README @@ -0,0 +1,29 @@ +Books that are "part of the stack" include these files by looking at their +branch. So the docs for Elasticsearch can use this: + +``` +include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] +``` + +Which will resolve to the `6.3.asciidoc` file for he 6.3 branch. Or the +`7.2.asciidoc` file for the 7.2 branch. Or `master.asciidoc` for the master +branch. + +NOTE: `current.asciidoc` is never automatically used. + +Books outside of the stack have three choices: + +1. Don't use these versions files at all. +2. Use the `current.asciidoc` file. +3. "Pin" theselves to some version of the stack. + +Not using these files is perfectly appopriate for books that don't link to the +stack. + +Using `current.asciidoc` is useful because we'll update on whenever we release +a new version of the stack so the doc will automatically update on release. + +"Pinning" the version of the stack that a book refers to is quite useful for +old versions of books for which consistently see broken links when we release +new versions of the docs. It could also be useful for books that need special +care when bumping the stack version. diff --git a/shared/versions/stack/current.asciidoc b/shared/versions/stack/current.asciidoc new file mode 100644 index 0000000000000..9c48381a070b3 --- /dev/null +++ b/shared/versions/stack/current.asciidoc @@ -0,0 +1 @@ +include::versions/stack/7.4.asciidoc[] From aefc97d4c5c59e9518d68a8e77ef5c17c5468e4f Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Thu, 19 Sep 2019 12:14:32 -0400 Subject: [PATCH 2/4] Update shared/versions/stack/README Co-Authored-By: Lisa Cawley --- shared/versions/stack/README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/shared/versions/stack/README b/shared/versions/stack/README index 40c0f41eda5e9..ed05a85dfa146 100644 --- a/shared/versions/stack/README +++ b/shared/versions/stack/README @@ -24,6 +24,6 @@ Using `current.asciidoc` is useful because we'll update on whenever we release a new version of the stack so the doc will automatically update on release. "Pinning" the version of the stack that a book refers to is quite useful for -old versions of books for which consistently see broken links when we release +old versions of books for which we consistently see broken links when we release new versions of the docs. It could also be useful for books that need special care when bumping the stack version. From 0b1b631cbb7897df5fb69d2ea8522565b93d838e Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Thu, 19 Sep 2019 13:22:40 -0400 Subject: [PATCH 3/4] Drop not using option --- shared/versions/stack/README | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/shared/versions/stack/README b/shared/versions/stack/README index ed05a85dfa146..270e69d805d12 100644 --- a/shared/versions/stack/README +++ b/shared/versions/stack/README @@ -11,14 +11,10 @@ branch. NOTE: `current.asciidoc` is never automatically used. -Books outside of the stack have three choices: +Books outside of the stack have two choices: -1. Don't use these versions files at all. -2. Use the `current.asciidoc` file. -3. "Pin" theselves to some version of the stack. - -Not using these files is perfectly appopriate for books that don't link to the -stack. +1. Use the `current.asciidoc` file. +2. "Pin" theselves to some version of the stack. Using `current.asciidoc` is useful because we'll update on whenever we release a new version of the stack so the doc will automatically update on release. From 0123667ae629eb9f2632b14a9b8a4c98eeca4f4b Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Thu, 19 Sep 2019 13:23:36 -0400 Subject: [PATCH 4/4] Update shared/versions/stack/README Co-Authored-By: Lisa Cawley --- shared/versions/stack/README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/shared/versions/stack/README b/shared/versions/stack/README index 270e69d805d12..9b3464d196a6d 100644 --- a/shared/versions/stack/README +++ b/shared/versions/stack/README @@ -16,7 +16,7 @@ Books outside of the stack have two choices: 1. Use the `current.asciidoc` file. 2. "Pin" theselves to some version of the stack. -Using `current.asciidoc` is useful because we'll update on whenever we release +Using `current.asciidoc` is useful because we'll update it whenever we release a new version of the stack so the doc will automatically update on release. "Pinning" the version of the stack that a book refers to is quite useful for