From e2f28bca7da9519f40443524adbf06c207e8c535 Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Mon, 29 Jun 2015 15:29:06 +0200 Subject: [PATCH 1/8] Updated documentation --- README.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index a715f48a..45eb55f0 100644 --- a/README.adoc +++ b/README.adoc @@ -21,8 +21,9 @@ You can generate your HTML5, PDF and EPUB documentation via https://github.com/a The project requires at least JDK 7. == Reference documentation +- http://swagger2markup.github.io/swagger2markup-docs/[Reference Documentation] +- https://github.com/Swagger2Markup/swagger2markup/blob/master/RELEASENOTES.adoc[Release notes] -The documentation can be found at http://swagger2markup.github.io/swagger2markup-docs/[Reference documentation] == License @@ -32,4 +33,4 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use http://www.apache.org/licenses/LICENSE-2.0 -Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. \ No newline at end of file +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. From 832813d40ad64189db80575b8f64e97da166987a Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Tue, 30 Jun 2015 08:26:05 +0200 Subject: [PATCH 2/8] Updated documentation --- README.adoc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.adoc b/README.adoc index 45eb55f0..296a4c54 100644 --- a/README.adoc +++ b/README.adoc @@ -24,6 +24,14 @@ The project requires at least JDK 7. - http://swagger2markup.github.io/swagger2markup-docs/[Reference Documentation] - https://github.com/Swagger2Markup/swagger2markup/blob/master/RELEASENOTES.adoc[Release notes] +== Community contributions + +Pull requests are welcome. + +* New feature https://github.com/Swagger2Markup/swagger2markup/issues/18[RobWin/Swagger2Markup#18] by https://github.com/sg-ad[@sg-ad]: In addition to the definitions.adoc you can also generate separate files for each definition model (ex: person.adoc, address.adoc, purchase.adoc). + +* New feature https://github.com/Swagger2Markup/swagger2markup/issues/21[RobWin/Swagger2Markup#21] by https://github.com/redowl[@redowl]: Support for both reference models and composed models. + == License From e8cdcabffeb3a808823565f4a6c071a5ae6a7448 Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Tue, 30 Jun 2015 08:36:08 +0200 Subject: [PATCH 3/8] Updated documentation --- README.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.adoc b/README.adoc index 296a4c54..f0a0a023 100644 --- a/README.adoc +++ b/README.adoc @@ -32,6 +32,8 @@ Pull requests are welcome. * New feature https://github.com/Swagger2Markup/swagger2markup/issues/21[RobWin/Swagger2Markup#21] by https://github.com/redowl[@redowl]: Support for both reference models and composed models. +== Questions +You can ask questions about Swagger2Markup in https://gitter.im/Swagger2Markup/swagger2markup[Gitter]. == License From fbb446875df5903b6e5af1dc6fe599de71cf9be6 Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Tue, 30 Jun 2015 08:38:54 +0200 Subject: [PATCH 4/8] Updated documentation --- README.adoc | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index f0a0a023..71120cf5 100644 --- a/README.adoc +++ b/README.adoc @@ -24,7 +24,9 @@ The project requires at least JDK 7. - http://swagger2markup.github.io/swagger2markup-docs/[Reference Documentation] - https://github.com/Swagger2Markup/swagger2markup/blob/master/RELEASENOTES.adoc[Release notes] -== Community contributions +== Contributing + +=== Community contributions Pull requests are welcome. @@ -32,8 +34,14 @@ Pull requests are welcome. * New feature https://github.com/Swagger2Markup/swagger2markup/issues/21[RobWin/Swagger2Markup#21] by https://github.com/redowl[@redowl]: Support for both reference models and composed models. -== Questions -You can ask questions about Swagger2Markup in https://gitter.im/Swagger2Markup/swagger2markup[Gitter]. +=== Questions +You can ask questions about Swagger2Markup in https://gitter.im/Swagger2Markup/swagger2markup[Gitter]. + +=== Bugs +If you believe you have found a bug, please take a moment to search the existing issues. If no one else has reported the problem, please open a new issue that describes the problem in detail and, ideally, includes a test that reproduces it. + +=== Enhancements +If you’d like an enhancement to be made to Swagger2Markup Docs, pull requests are most welcome. The source code is on GitHub. You may want to search the existing issues and pull requests to see if the enhancement is already being worked on. You may also want to open a new issue to discuss a possible enhancement before work on it begins. == License From 3163c077a1e2cb372d238ecb60254c551189d1ad Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Tue, 30 Jun 2015 08:39:46 +0200 Subject: [PATCH 5/8] Updated documentation --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 71120cf5..9ce26998 100644 --- a/README.adoc +++ b/README.adoc @@ -41,7 +41,7 @@ You can ask questions about Swagger2Markup in https://gitter.im/Swagger2Markup/s If you believe you have found a bug, please take a moment to search the existing issues. If no one else has reported the problem, please open a new issue that describes the problem in detail and, ideally, includes a test that reproduces it. === Enhancements -If you’d like an enhancement to be made to Swagger2Markup Docs, pull requests are most welcome. The source code is on GitHub. You may want to search the existing issues and pull requests to see if the enhancement is already being worked on. You may also want to open a new issue to discuss a possible enhancement before work on it begins. +If you’d like an enhancement to be made to Swagger2Markup, pull requests are most welcome. The source code is on GitHub. You may want to search the existing issues and pull requests to see if the enhancement is already being worked on. You may also want to open a new issue to discuss a possible enhancement before work on it begins. == License From 85ef33a7200027e0d4043232a9d505aa5bbd9511 Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Mon, 6 Jul 2015 08:49:22 +0200 Subject: [PATCH 6/8] Updated documentation --- README.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 9ce26998..92432c5f 100644 --- a/README.adoc +++ b/README.adoc @@ -12,11 +12,11 @@ The primary goal of this project is to *simplify the generation of an up-to-date Swagger2Markup converts a Swagger JSON or YAML file into several *AsciiDoc* or *GitHub Flavored Markdown* documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification. Internally it uses the _official_ https://github.com/swagger-api/swagger-parser[swagger-parser] and my https://github.com/RobWin/markup-document-builder[markup-document-builder]. -You can use Swagger2Markup to convert your contract-first Swagger YAML file into a human-readable format and combine it with hand-written documentation. As an alternative, you can choose the code-first approach and use Swagger2Markup together with https://github.com/swagger-api/swagger-core/tree/master/samples/java-jersey2[Swagger JAX-RS], https://github.com/springfox/springfox[springfox] or https://github.com/spring-projects/spring-restdocs[spring-restdocs]. See https://github.com/RobWin/swagger2markup#usage-guide[usage guide] below. If you are are Gradle or Maven user, you can also use the https://github.com/RobWin/swagger2markup-gradle-plugin[Swagger2Markup Gradle Plugin] or https://github.com/redowl/swagger2markup-maven-plugin[Swagger2markup Maven Plugin]. +You can use Swagger2Markup to convert your contract-first Swagger YAML file into a human-readable format and combine it with hand-written documentation. As an alternative, you can choose the code-first approach and use Swagger2Markup together with https://github.com/swagger-api/swagger-core/tree/master/samples/java-jersey2[Swagger JAX-RS], https://github.com/springfox/springfox[springfox] or https://github.com/spring-projects/spring-restdocs[spring-restdocs]. If you are are Gradle or Maven user, you can also use the https://github.com/RobWin/swagger2markup-gradle-plugin[Swagger2Markup Gradle Plugin] or https://github.com/redowl/swagger2markup-maven-plugin[Swagger2markup Maven Plugin]. http://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc] is preferable to Markdown as it has more features. AsciiDoc is a text document format for writing documentation, articles, books, ebooks, slideshows, web pages and blogs. AsciiDoc files can be converted to *HTML*, *PDF* and *EPUB*. AsciiDoc is much better suited for describing public APIs than *JavaDoc* or *Annotations*. -You can generate your HTML5, PDF and EPUB documentation via https://github.com/asciidoctor/asciidoctorj[asciidoctorj] or even better via the https://github.com/asciidoctor/asciidoctor-gradle-plugin[asciidoctor-gradle-plugin] or https://github.com/asciidoctor/asciidoctor-maven-plugin[asciidoctor-maven-plugin]. You can also use https://github.com/jbake-org/jbake[JBake], https://github.com/tomchristie/mkdocs[MkDocs], https://github.com/rtfd/readthedocs.org[ReadTheDocs] or https://github.com/tripit/slate[slate] to publish your AsciiDoc or Markdown documentation. +You can generate your HTML5, PDF and EPUB documentation via https://github.com/asciidoctor/asciidoctorj[asciidoctorj] or even better via the https://github.com/asciidoctor/asciidoctor-gradle-plugin[asciidoctor-gradle-plugin] or https://github.com/asciidoctor/asciidoctor-maven-plugin[asciidoctor-maven-plugin]. You can also use https://readme.io/[ReadMe.io], https://github.com/jbake-org/jbake[JBake], https://github.com/tomchristie/mkdocs[MkDocs], https://github.com/rtfd/readthedocs.org[ReadTheDocs] or https://github.com/tripit/slate[slate] to publish your AsciiDoc or Markdown documentation. The project requires at least JDK 7. From a34807e5c90f3affe77330c8af9f341b23c13db0 Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Thu, 9 Jul 2015 08:08:57 +0200 Subject: [PATCH 7/8] Updated Travis-CI Batch --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 92432c5f..a50cef9d 100644 --- a/README.adoc +++ b/README.adoc @@ -3,7 +3,7 @@ :version: < :hardbreaks: -image:https://travis-ci.org/RobWin/swagger2markup.svg?branch=master["Build Status", link="https://travis-ci.org/RobWin/swagger2markup"] image:https://coveralls.io/repos/RobWin/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/RobWin/swagger2markup"] image:https://api.bintray.com/packages/robwin/maven/swagger2markup/images/download.svg[link="https://bintray.com/robwin/maven/swagger2markup/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"] +image:https://travis-ci.org/Swagger2Markup/swagger2markup.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/swagger2markup"] image:https://coveralls.io/repos/RobWin/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/RobWin/swagger2markup"] image:https://api.bintray.com/packages/robwin/maven/swagger2markup/images/download.svg[link="https://bintray.com/robwin/maven/swagger2markup/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"] == Overview From 1dc9a07cb91ae4e2904807bcf9c503e517a31adb Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Tue, 14 Jul 2015 08:33:46 +0200 Subject: [PATCH 8/8] Updated documentation --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index a50cef9d..b6976f4a 100644 --- a/README.adoc +++ b/README.adoc @@ -21,7 +21,7 @@ You can generate your HTML5, PDF and EPUB documentation via https://github.com/a The project requires at least JDK 7. == Reference documentation -- http://swagger2markup.github.io/swagger2markup-docs/[Reference Documentation] +- http://swagger2markup.readme.io/[Reference Documentation] - https://github.com/Swagger2Markup/swagger2markup/blob/master/RELEASENOTES.adoc[Release notes] == Contributing