Skip to content

Commit 8bd45cd

Browse files
committed
Polish contribution
Closes gh-1509
1 parent ea0e222 commit 8bd45cd

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

CONTRIBUTING-DOCUMENTATION.adoc

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
= How to contribute to the reference manual
22

3-
The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor].
4-
This document describes how to contribute documentation updates.
3+
The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor]. This
4+
document describes how to contribute documentation updates.
55

66
== Building with Gradle
77

8-
You can build the documentation using Gradle using the `asciidoctor` task. For example, from
9-
the project root execute the following command:
8+
You can build the documentation using Gradle using the `asciidoctor` task. For example,
9+
from the project root execute the following command:
1010

11+
[indent=0]
12+
----
1113
./gradlew asciidoctor
14+
----
1215

1316
The generated reference manual will then be available at `build/asciidoc/html5/index.html`.
1417

@@ -22,9 +25,9 @@ http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc
2225
with Live Preview] document. Once you have done that, there are additional gems to
2326
install to make it work (assuming that you are using http://livereload.com/[LiveReload]):
2427

25-
[source]
28+
[indent=0]
2629
----
27-
gem install guard-rspec guard-livereload
30+
gem install guard-rspec guard-livereload
2831
----
2932

3033
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
3336

3437
== Troubleshooting
3538

36-
* If you are using LiveReload, make sure to select _Allow access to file
37-
URLs_ in the LiveEdit plugin options of your browser.
38-
* The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty
39-
when it is disabled and full when the plugin is active. Make sure to enable it
40-
on the tab displaying the `index.html` file.
41-
* Ensure you are _not_ running `guard start` at all as two instances could not run
42-
at the same time. To exit a current session in a clean way, type `e` in the shell.
39+
* If you are using LiveReload, make sure to select _Allow access to file URLs_ in the
40+
LiveEdit plugin options of your browser.
41+
* The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty when it
42+
is disabled and full when the plugin is active. Make sure to enable it on the tab
43+
displaying the `index.html` file.
44+
* Ensure you are _not_ running `guard start` at all as two instances could not run at the
45+
same time. To exit a current session in a clean way, type `e` in the shell.
4346

4447
== Documentation Notes
4548

0 commit comments

Comments
 (0)