Skip to content

Commit a8f1028

Browse files
committed
Merge pull request #1509 from Buzzardo:master
* pr/1509: Polish contribution Polish
2 parents 44e8cdc + 8bd45cd commit a8f1028

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

CONTRIBUTING-DOCUMENTATION.adoc

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,30 @@ 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

15-
== Live editing
18+
== Live Editing
1619

1720
One of the nice features about using asciidoctor is the support for live editing.
1821

1922
You will find a Guardfile already present at `spring-framework/src/asciidoc/Guardfile`.
2023
Make sure first to follow the setup instructions within the
21-
http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc with Live Preview]
22-
document. Once you have done that, there are additional gems to install to make it work
23-
(assuming that you are using http://livereload.com/[LiveReload]):
24+
http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc
25+
with Live Preview] document. Once you have done that, there are additional gems to
26+
install to make it work (assuming that you are using http://livereload.com/[LiveReload]):
2427

28+
[indent=0]
29+
----
2530
gem install guard-rspec guard-livereload
31+
----
2632

2733
When running `guard start` within the `src/asciidoc/` folder, any changes to the
2834
`src/asciidoc/index.adoc` file will automatically be written to
@@ -31,21 +37,20 @@ When running `guard start` within the `src/asciidoc/` folder, any changes to the
3137
== Troubleshooting
3238

3339
* If you are using LiveReload, make sure to select _Allow access to file URLs_ in the
34-
LiveEdit plugin options of your browser.
35-
* The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty when it is
36-
disabled and full when the plugin is active. Make sure to enable it on the tab
37-
displaying the `index.html` file.
38-
* Ensure you are _not_ running guard start at all as two instances could not run at the
39-
same time. To exit a current session in a clean way, just type e in the shell.
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.
4046

41-
== Documentation notes
47+
== Documentation Notes
4248

43-
Some notes on documentation
49+
Some notes on the documentation.
4450

4551
* Documentation is wrapped at 90 chars; ensure that you manually wrap your edits.
4652
* Tabs are used for indentation; do not use spaces.
4753
* Follow the existing style when inserting `source` blocks.
4854
* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[Asciidoctor Quick Reference]
4955
* http://asciidoctor.org/docs/user-manual/[Asciidoctor Manual]
5056
* http://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoctor Writers Guide]
51-

0 commit comments

Comments
 (0)