-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added docs, restructured project (#30)
- Loading branch information
1 parent
957de23
commit d6ec022
Showing
73 changed files
with
722 additions
and
654 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,3 +10,4 @@ dependency-reduced-pom.xml | |
buildNumber.properties | ||
.mvn/timing.properties | ||
|
||
target |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
// Do not edit this file (e.g. go instead to src/main/asciidoc) | ||
|
||
image::https://travis-ci.org/Codearte/accurest-maven-plugin.svg?branch=master[Build Status, link=https://travis-ci.org/Codearte/accurest-maven-plugin] | ||
image::https://img.shields.io/github/issues/Codearte/accurest/maven.svg[Github Issues, link=https://github.com/Codearte/accurest/labels/maven] | ||
|
||
//[![Maven Central](https://img.shields.io/maven-central/v/io.codearte.accurest/accurest-maven-plugin.svg)](https://maven-badges.herokuapp.com/maven-central/io.codearte.accurest/accurest-maven-plugin) | ||
|
||
= Spring Cloud Contract Verifier Maven Plugin | ||
|
||
== Documentation | ||
|
||
* http://codearte.github.io/accurest/[Spring Cloud Contract Verifier Documentation] | ||
* http://codearte.github.io/accurest-maven-plugin/plugin-info.html[Spring Cloud Contract Verifier Maven Plugin Documentation Site] | ||
|
||
== Contributing | ||
|
||
Spring Cloud is released under the non-restrictive Apache 2.0 license, | ||
and follows a very standard Github development process, using Github | ||
tracker for issues and merging pull requests into master. If you want | ||
to contribute even something trivial please do not hesitate, but | ||
follow the guidelines below. | ||
|
||
=== Sign the Contributor License Agreement | ||
Before we accept a non-trivial patch or pull request we will need you to sign the | ||
https://support.springsource.com/spring_committer_signup[contributor's agreement]. | ||
Signing the contributor's agreement does not grant anyone commit rights to the main | ||
repository, but it does mean that we can accept your contributions, and you will get an | ||
author credit if we do. Active contributors might be asked to join the core team, and | ||
given the ability to merge pull requests. | ||
|
||
=== Code of Conduct | ||
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of | ||
conduct]. By participating, you are expected to uphold this code. Please report | ||
unacceptable behavior to spring-code-of-conduct@pivotal.io. | ||
|
||
=== Code Conventions and Housekeeping | ||
None of these is essential for a pull request, but they will all help. They can also be | ||
added after the original pull request but before a merge. | ||
|
||
* Use the Spring Framework code format conventions. If you use Eclipse | ||
you can import formatter settings using the | ||
`eclipse-code-formatter.xml` file from the | ||
https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring | ||
Cloud Build] project. If using IntelliJ, you can use the | ||
http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter | ||
Plugin] to import the same file. | ||
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an | ||
`@author` tag identifying you, and preferably at least a paragraph on what the class is | ||
for. | ||
* Add the ASF license header comment to all new `.java` files (copy from existing files | ||
in the project) | ||
* Add yourself as an `@author` to the .java files that you modify substantially (more | ||
than cosmetic changes). | ||
* Add some Javadocs and, if you change the namespace, some XSD doc elements. | ||
* A few unit tests would help a lot as well -- someone has to do it. | ||
* If no-one else is using your branch, please rebase it against the current master (or | ||
other target branch in the main project). | ||
* When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], | ||
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit | ||
message (where XXXX is the issue number). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
<modelVersion>4.0.0</modelVersion> | ||
<parent> | ||
<groupId>org.springframework.cloud</groupId> | ||
<artifactId>spring-cloud-build</artifactId> | ||
<version>1.1.1.RELEASE</version> | ||
<relativePath/> | ||
<!-- lookup parent from repository --> | ||
</parent> | ||
<artifactId>spring-cloud-contract-verifier-docs</artifactId> | ||
<packaging>pom</packaging> | ||
<name>Spring Cloud Contract Verifier Docs</name> | ||
<description>Spring Contract Verifier Docs</description> | ||
<properties> | ||
<docs.main>spring-cloud-contract-verifier-maven-plugin</docs.main> | ||
<main.basedir>${basedir}/..</main.basedir> | ||
</properties> | ||
<profiles> | ||
<profile> | ||
<id>docs</id> | ||
<build> | ||
<plugins> | ||
<plugin> | ||
<groupId>org.asciidoctor</groupId> | ||
<artifactId>asciidoctor-maven-plugin</artifactId> | ||
<version>1.5.3</version> | ||
<inherited>false</inherited> | ||
</plugin> | ||
<plugin> | ||
<groupId>org.apache.maven.plugins</groupId> | ||
<artifactId>maven-antrun-plugin</artifactId> | ||
<inherited>false</inherited> | ||
</plugin> | ||
<plugin> | ||
<groupId>org.codehaus.mojo</groupId> | ||
<artifactId>build-helper-maven-plugin</artifactId> | ||
<inherited>false</inherited> | ||
</plugin> | ||
</plugins> | ||
</build> | ||
</profile> | ||
</profiles> | ||
</project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
image::https://travis-ci.org/Codearte/accurest-maven-plugin.svg?branch=master[Build Status, link=https://travis-ci.org/Codearte/accurest-maven-plugin] | ||
image::https://img.shields.io/github/issues/Codearte/accurest/maven.svg[Github Issues, link=https://github.com/Codearte/accurest/labels/maven] | ||
|
||
//[![Maven Central](https://img.shields.io/maven-central/v/io.codearte.accurest/accurest-maven-plugin.svg)](https://maven-badges.herokuapp.com/maven-central/io.codearte.accurest/accurest-maven-plugin) | ||
|
||
= Spring Cloud Contract Verifier Maven Plugin | ||
|
||
== Documentation | ||
|
||
* http://codearte.github.io/accurest/[Spring Cloud Contract Verifier Documentation] | ||
* http://codearte.github.io/accurest-maven-plugin/plugin-info.html[Spring Cloud Contract Verifier Maven Plugin Documentation Site] | ||
|
||
== Contributing | ||
|
||
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] |
3 changes: 3 additions & 0 deletions
3
docs/src/main/asciidoc/spring-cloud-contract-verifier-maven-plugin.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
:root_folder: ../../../../spring-cloud-contract-verifier-maven-plugin | ||
|
||
include::{root_folder}/src/site/asciidoc/complex-content.adoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
#!/usr/bin/env ruby | ||
|
||
base_dir = File.join(File.dirname(__FILE__),'../../..') | ||
src_dir = File.join(base_dir, "/src/main/asciidoc") | ||
require 'asciidoctor' | ||
require 'optparse' | ||
|
||
options = {} | ||
file = "#{src_dir}/README.adoc" | ||
|
||
OptionParser.new do |o| | ||
o.on('-o OUTPUT_FILE', 'Output file (default is stdout)') { |file| options[:to_file] = file unless file=='-' } | ||
o.on('-h', '--help') { puts o; exit } | ||
o.parse! | ||
end | ||
|
||
file = ARGV[0] if ARGV.length>0 | ||
|
||
# Copied from https://github.com/asciidoctor/asciidoctor-extensions-lab/blob/master/scripts/asciidoc-coalescer.rb | ||
doc = Asciidoctor.load_file file, safe: :unsafe, header_only: true, attributes: options[:attributes] | ||
header_attr_names = (doc.instance_variable_get :@attributes_modified).to_a | ||
header_attr_names.each {|k| doc.attributes[%(#{k}!)] = '' unless doc.attr? k } | ||
attrs = doc.attributes | ||
attrs['allow-uri-read'] = true | ||
puts attrs | ||
|
||
out = "// Do not edit this file (e.g. go instead to src/main/asciidoc)\n\n" | ||
doc = Asciidoctor.load_file file, safe: :unsafe, parse: false, attributes: attrs | ||
out << doc.reader.read | ||
|
||
unless options[:to_file] | ||
puts out | ||
else | ||
File.open(options[:to_file],'w+') do |file| | ||
file.write(out) | ||
end | ||
end |
Oops, something went wrong.