Browse Source

Polish

See gh-1509
pull/1510/head
Jay Bryant 9 years ago committed by Stephane Nicoll
parent
commit
ea0e22218f
  1. 36
      CONTRIBUTING-DOCUMENTATION.adoc

36
CONTRIBUTING-DOCUMENTATION.adoc

@ -1,7 +1,7 @@
= How to contribute to the reference manual = How to contribute to the reference manual
The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor]. This The Spring Framework reference manual uses http://asciidoctor.org/[asciidoctor].
document describes how to contribute documentation updates. This document describes how to contribute documentation updates.
== Building with Gradle == 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`. 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. 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`. You will find a Guardfile already present at `spring-framework/src/asciidoc/Guardfile`.
Make sure first to follow the setup instructions within the Make sure first to follow the setup instructions within the
http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc with Live Preview] http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/[Editing AsciiDoc
document. Once you have done that, there are additional gems to install to make it work with Live Preview] document. Once you have done that, there are additional gems to
(assuming that you are using http://livereload.com/[LiveReload]): 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 When running `guard start` within the `src/asciidoc/` folder, any changes to the
`src/asciidoc/index.adoc` file will automatically be written to `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 == Troubleshooting
* If you are using LiveReload, make sure to select _Allow access to file URLs_ in the * If you are using LiveReload, make sure to select _Allow access to file
LiveEdit plugin options of your browser. 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 * The icon used to enable _LiveReload_ can be a bit confusing. The dot is empty
disabled and full when the plugin is active. Make sure to enable it on the tab when it is disabled and full when the plugin is active. Make sure to enable it
displaying the `index.html` file. 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 * Ensure you are _not_ running `guard start` at all as two instances could not run
same time. To exit a current session in a clean way, just type e in the shell. 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. * Documentation is wrapped at 90 chars; ensure that you manually wrap your edits.
* Tabs are used for indentation; do not use spaces. * 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/asciidoc-syntax-quick-reference/[Asciidoctor Quick Reference]
* http://asciidoctor.org/docs/user-manual/[Asciidoctor Manual] * http://asciidoctor.org/docs/user-manual/[Asciidoctor Manual]
* http://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoctor Writers Guide] * http://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoctor Writers Guide]

Loading…
Cancel
Save