Polish the documentation produced by the samples

- Correct the location of the Git repository
- Correct the location of the sample within the repository
- Update the build instructions for the Data REST sample to use Maven
- Move the table of contents to the left
- Add section links

Closes gh-113
This commit is contained in:
Andy Wilkinson
2015-09-10 10:00:18 +01:00
parent ed3d5f0a59
commit 11c0945d10
4 changed files with 25 additions and 25 deletions

View File

@@ -1,11 +1,11 @@
= RESTful Notes API Guide
Andy Wilkinson;
:doctype: book
:toc:
:sectanchors:
:sectlinks:
:toclevels: 4
:icons: font
:source-highlighter: highlightjs
:toc: left
:toclevels: 4
:sectlinks:
[[overview]]
= Overview

View File

@@ -1,9 +1,11 @@
= RESTful Notes User Guide
= RESTful Notes Getting Started Guide
Andy Wilkinson;
:doctype: book
:toc:
:toclevels: 4
:icons: font
:source-highlighter: highlightjs
:toc: left
:toclevels: 4
:sectlinks:
[introduction]
= Introduction
@@ -21,22 +23,20 @@ to describe the relationships between resources and to allow navigation between
RESTful Notes is written using http://projects.spring.io/spring-boot[Spring Boot] which
makes it easy to get it up and running so that you can start exploring the REST API.
At the moment, binaries for RESTful Notes are not published anywhere. However, building
and running it from source is straightforward. The first step is to clone the Git
repository:
The first step is to clone the Git repository:
[source,bash]
----
$ git clone https://github.com/wilkinsona/spring-restdocs
$ git clone https://github.com/spring-projects/spring-restdocs
----
Once the clone is complete, you're ready to get the service up and running:
[source,bash]
----
$ cd rest-notes
$ ./gradlew build
$ java -jar build/libs/*.jar
$ cd samples/rest-notes-spring-data-rest
$ mvn clean package
$ java -jar target/*.jar
----
You can check that the service is up and running by executing a simple request using

View File

@@ -1,11 +1,11 @@
= RESTful Notes API Guide
Andy Wilkinson;
:doctype: book
:toc:
:sectanchors:
:sectlinks:
:toclevels: 4
:icons: font
:source-highlighter: highlightjs
:toc: left
:toclevels: 4
:sectlinks:
[[overview]]
= Overview

View File

@@ -1,9 +1,11 @@
= RESTful Notes Getting Started Guide
Andy Wilkinson;
:doctype: book
:toc:
:toclevels: 4
:icons: font
:source-highlighter: highlightjs
:toc: left
:toclevels: 4
:sectlinks:
[introduction]
= Introduction
@@ -21,20 +23,18 @@ to describe the relationships between resources and to allow navigation between
RESTful Notes is written using http://projects.spring.io/spring-boot[Spring Boot] which
makes it easy to get it up and running so that you can start exploring the REST API.
At the moment, binaries for RESTful Notes are not published anywhere. However, building
and running it from source is straightforward. The first step is to clone the Git
repository:
The first step is to clone the Git repository:
[source,bash]
----
$ git clone https://github.com/wilkinsona/spring-restdocs
$ git clone https://github.com/spring-projects/spring-restdocs
----
Once the clone is complete, you're ready to get the service up and running:
[source,bash]
----
$ cd rest-notes
$ cd samples/rest-notes-spring-hateoas
$ ./gradlew build
$ java -jar build/libs/*.jar
----