Skip to content

Commit 678a786

Browse files
committed
Merge pull request #1512 from Buzzardo:CONTRIBUTING-DOCUMENTATION-edit
* pr/1512: CONTRIBUTING-DOCUMENTATION.adoc edit
2 parents 3a00643 + 3736b04 commit 678a786

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

CONTRIBUTING-DOCUMENTATION.adoc

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= How to contribute to the reference manual
1+
= How to Contribute to the Reference Manual
22

33
The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor]. This
44
document describes how to contribute documentation updates.
@@ -13,14 +13,16 @@ from the project root execute the following command:
1313
./gradlew asciidoctor
1414
----
1515

16-
The generated reference manual will then be available at `build/asciidoc/html5/index.html`.
16+
The generated reference manual will then be available at
17+
`build/asciidoc/html5/index.html`.
1718

1819
== Live Editing
1920

20-
One of the nice features about using asciidoctor is the support for live editing.
21+
One of the nice features about using Asciidoctor is the support for live editing.
2122

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

3335
When running `guard start` within the `src/asciidoc/` folder, any changes to the
34-
`src/asciidoc/index.adoc` file will automatically be written to
36+
`src/asciidoc/index.adoc` file are automatically written to
3537
`src/asciidoc/build/index.html`.
3638

3739
== Troubleshooting
3840

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

4749
== Documentation Notes
4850

4951
Some notes on the documentation.
5052

51-
* Documentation is wrapped at 90 chars; ensure that you manually wrap your edits.
52-
* Tabs are used for indentation; do not use spaces.
53+
* Documentation is wrapped at 90 chars. Ensure that you manually wrap your edits.
54+
* Tabs are used for indentation. Do not use spaces.
5355
* Follow the existing style when inserting `source` blocks.
56+
57+
Here are some useful resources for working with Asciidoctor:
5458
* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[Asciidoctor Quick Reference]
5559
* http://asciidoctor.org/docs/user-manual/[Asciidoctor Manual]
5660
* http://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoctor Writers Guide]

0 commit comments

Comments
 (0)