From ea0e22218f7f9dbb35e95ff9872ce947043db29b Mon Sep 17 00:00:00 2001 From: Jay Bryant Date: Tue, 29 Aug 2017 13:13:26 -0500 Subject: [PATCH 1/2] Polish See gh-1509 --- CONTRIBUTING-DOCUMENTATION.adoc | 36 +++++++++++++++++---------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING-DOCUMENTATION.adoc b/CONTRIBUTING-DOCUMENTATION.adoc index d93c2362b7e..68311ac0762 100644 --- a/CONTRIBUTING-DOCUMENTATION.adoc +++ b/CONTRIBUTING-DOCUMENTATION.adoc @@ -1,7 +1,7 @@ = How to contribute to the reference manual -The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor]. This -document describes how to contribute documentation updates. +The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor]. +This document describes how to contribute documentation updates. == Building with Gradle @@ -12,17 +12,20 @@ the project root execute the following command: The generated reference manual will then be available at `build/asciidoc/html5/index.html`. -== Live editing +== Live Editing One of the nice features about using asciidoctor is the support for live editing. You will find a Guardfile already present at `spring-framework/src/asciidoc/Guardfile`. Make sure first to follow the setup instructions within the -http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc with Live Preview] -document. Once you have done that, there are additional gems to install to make it work -(assuming that you are using http://livereload.com/[LiveReload]): +http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc +with Live Preview] document. Once you have done that, there are additional gems to +install to make it work (assuming that you are using http://livereload.com/[LiveReload]): - gem install guard-rspec guard-livereload +[source] +---- +gem install guard-rspec guard-livereload +---- When running `guard start` within the `src/asciidoc/` folder, any changes to the `src/asciidoc/index.adoc` file will automatically be written to @@ -30,17 +33,17 @@ When running `guard start` within the `src/asciidoc/` folder, any changes to the == Troubleshooting -* If you are using LiveReload, make sure to select _Allow access to file URLs_ in the - LiveEdit plugin options of your browser. -* The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty when it is - disabled and full when the plugin is active. Make sure to enable it on the tab - displaying the `index.html` file. -* Ensure you are _not_ running guard start at all as two instances could not run at the - same time. To exit a current session in a clean way, just type e in the shell. +* If you are using LiveReload, make sure to select _Allow access to file +URLs_ in the LiveEdit plugin options of your browser. +* The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty +when it is disabled and full when the plugin is active. Make sure to enable it +on the tab displaying the `index.html` file. +* Ensure you are _not_ running `guard start` at all as two instances could not run +at the same time. To exit a current session in a clean way, type `e` in the shell. -== Documentation notes +== Documentation Notes -Some notes on documentation +Some notes on the documentation. * Documentation is wrapped at 90 chars; ensure that you manually wrap your edits. * Tabs are used for indentation; do not use spaces. @@ -48,4 +51,3 @@ Some notes on documentation * http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[Asciidoctor Quick Reference] * http://asciidoctor.org/docs/user-manual/[Asciidoctor Manual] * http://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoctor Writers Guide] - From 8bd45cdec43e6b2c79f0f14d8c7bef6b9137e21a Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Wed, 30 Aug 2017 18:13:10 +0200 Subject: [PATCH 2/2] Polish contribution Closes gh-1509 --- CONTRIBUTING-DOCUMENTATION.adoc | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING-DOCUMENTATION.adoc b/CONTRIBUTING-DOCUMENTATION.adoc index 68311ac0762..900e9d42a99 100644 --- a/CONTRIBUTING-DOCUMENTATION.adoc +++ b/CONTRIBUTING-DOCUMENTATION.adoc @@ -1,14 +1,17 @@ = How to contribute to the reference manual -The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor]. -This document describes how to contribute documentation updates. +The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor]. This +document describes how to contribute documentation updates. == Building with Gradle -You can build the documentation using Gradle using the `asciidoctor` task. For example, from -the project root execute the following command: +You can build the documentation using Gradle using the `asciidoctor` task. For example, +from the project root execute the following command: +[indent=0] +---- ./gradlew asciidoctor +---- The generated reference manual will then be available at `build/asciidoc/html5/index.html`. @@ -22,9 +25,9 @@ http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc with Live Preview] document. Once you have done that, there are additional gems to install to make it work (assuming that you are using http://livereload.com/[LiveReload]): -[source] +[indent=0] ---- -gem install guard-rspec guard-livereload + gem install guard-rspec guard-livereload ---- When running `guard start` within the `src/asciidoc/` folder, any changes to the @@ -33,13 +36,13 @@ When running `guard start` within the `src/asciidoc/` folder, any changes to the == Troubleshooting -* If you are using LiveReload, make sure to select _Allow access to file -URLs_ in the LiveEdit plugin options of your browser. -* The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty -when it is disabled and full when the plugin is active. Make sure to enable it -on the tab displaying the `index.html` file. -* Ensure you are _not_ running `guard start` at all as two instances could not run -at the same time. To exit a current session in a clean way, type `e` in the shell. +* If you are using LiveReload, make sure to select _Allow access to file URLs_ in the +LiveEdit plugin options of your browser. +* The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty when it +is disabled and full when the plugin is active. Make sure to enable it on the tab +displaying the `index.html` file. +* Ensure you are _not_ running `guard start` at all as two instances could not run at the +same time. To exit a current session in a clean way, type `e` in the shell. == Documentation Notes