From 9370692bb779ffcff601d944a21600ebc32fb5f7 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 25 Jun 2015 14:57:47 +0100 Subject: [PATCH] Initialise the project page --- .ruby-version | 2 +- _config.yml | 8 +++--- index.html | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 76 insertions(+), 5 deletions(-) create mode 100644 index.html diff --git a/.ruby-version b/.ruby-version index 31af4996..fa6db0e9 100644 --- a/.ruby-version +++ b/.ruby-version @@ -1 +1 @@ -ruby-1.9.3 \ No newline at end of file +1.9.3-p550 \ No newline at end of file diff --git a/_config.yml b/_config.yml index ddc41fb5..6c56dbdf 100644 --- a/_config.yml +++ b/_config.yml @@ -10,17 +10,17 @@ redcarpet: ### The following properties will change on a project-by-project basis # Context path in the remote website (usually /), will be prepended to absolute URLs for static resources -baseurl: /gh-pages +baseurl: /spring-restdocs # Name of the project for display in places like page titles -name: Spring Framework +name: Spring REST Docs # ID of the project in the metadata API at spring.io (if this is not a # valid project ID the javascript widgets in the home page will not work) -project: spring-framework +project: spring-restdocs # Project github URL -github_repo_url: http://github.com/spring-projects/spring-framework +github_repo_url: http://github.com/spring-projects/spring-restdocs # Project forum URL forum: http://forum.spring.io/forum/spring-projects/container diff --git a/index.html b/index.html new file mode 100644 index 00000000..521fb3c8 --- /dev/null +++ b/index.html @@ -0,0 +1,71 @@ +--- +# The name of your project +title: Spring REST Docs + +badges: + + # Customize your project's badges. Delete any entries that do not apply. + custom: + - name: Source (GitHub) + url: https://github.com/spring-projects/spring-restdocs + icon: github + + - name: Issues (GitHub) + url: https://github.com/spring-projects/spring-restdocs/issues + icon: tracking + + - name: CI (Bamboo) + url: https://build.spring.io/browse/SRD + icon: ci + + - name: StackOverflow + url: http://stackoverflow.com/questions/tagged/spring-restdocs + icon: stackoverflow + + - name: Metrics (SonarQube) + url: https://sonar.spring.io/dashboard/index/org.springframework.restdocs:spring-restdocs + icon: metrics + +--- + + + +{% capture billboard_description %} + +Document RESTful services by combining hand-written documentation with auto-generated +snippets produced with Spring MVC Test. + +{% endcapture %} + +{% capture main_content %} + +Spring REST Docs helps you to document RESTful services. It combines hand-written +documentation written with [Asciidoctor](http://asciidoctor.org/) and auto-generated +snippets produced with [Spring MVC Test](http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle#spring-mvc-test-framework). This approach frees you from the limitations imposed by tools like +[Swagger](http://swagger.io/). It helps you to produce documentation that is accurate, +concise, and well-structured. This documentation then allows your users to get the +information they need with a minimum of fuss. + + +## Quick Start + +Please refer to the [getting started section](http://docs.spring.io/spring-restdocs/docs/1.0.x/reference/html5/#getting-started) +of the [reference documentation](http://docs.spring.io/spring-restdocs/docs/1.0.x/reference/html5/) +to get started. + +{% include download_widget.md %} + +{% endcapture %} + +{% capture related_resources %} + +### Sample Projects + +* [Rest Notes, built with Spring HATEOAS](https://github.com/spring-projects/spring-restdocs/tree/master/samples/rest-notes-spring-hateoas) +* [Rest Notes, built with Spring Data REST](https://github.com/spring-projects/spring-restdocs/tree/master/samples/rest-notes-spring-data-rest) + +{% endcapture %} + + +{% include project_page.html %} +