Skip to content
Permalink
Browse files
Set up asciidoc based documentation.
Patch by Jon Haddad; Reviewed by Dinesh Joshi for CASSANDRASC-15
  • Loading branch information
rustyrazorblade committed Apr 23, 2020
1 parent 56f547f commit d57f2a487167f2b0ea5e71b93ff856b6324ee1e0
Showing 7 changed files with 87 additions and 2 deletions.
@@ -110,6 +110,15 @@ jobs:
- checkout
- run: ./gradlew jibDockerBuild

docs_build:
<<: *base_job
steps:
- checkout
- install_common
- install_java:
version: adoptopenjdk-11-hotspot
- run: ./gradlew build
- run: test -f build/docs/html5/user.html

workflows:
version: 2
@@ -126,4 +135,5 @@ workflows:
jobs:
- deb_build_install
- rpm_build_install
- docker_build
- docker_build
- docs_build
@@ -1,5 +1,6 @@
1.0.0
-----
* Set up asciidoc based documentation (CASSANDRASC-15)
* Gradle can now generate Deb packages, RPMs and Docker containers (CASSANDRASC-14)
* Security patch to fix incorrect usage of yaml configuration (CASSANDRASC-12)
* Build and Test with both Java 8 & 11 in Circle CI (CASSANDRA-15611)
@@ -167,6 +167,15 @@ task integrationTest(type: Test) {
shouldRunAfter test
}

// copy the user documentation to the final build
task copyDocs(type: Copy, dependsOn: ':docs:asciidoctor') {
from(tasks.getByPath(":docs:asciidoctor").outputs) {
include "**/*.html"
}
into "build/docs/"
exclude "tmp"
}

checkstyle {
toolVersion '7.8.1'
configFile file("checkstyle.xml")
@@ -216,5 +225,5 @@ applicationDistribution.from("LICENSE.txt") {
// copyDist gets called on every build
copyDist.dependsOn installDist, copyJolokia
check.dependsOn checkstyleMain, checkstyleTest, integrationTest, jacocoTestReport
build.dependsOn copyDist, generateReDoc, generateSwaggerUI, copyJolokia
build.dependsOn copyDist, generateReDoc, generateSwaggerUI, copyJolokia, copyDocs
run.dependsOn build
@@ -0,0 +1,16 @@
buildscript {
repositories {
jcenter()
}

dependencies {
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.9.2'
}
}

apply plugin: 'org.asciidoctor.convert'

asciidoctor {
sourceDir = file("src")
outputDir = file("build")
}
@@ -0,0 +1,30 @@
# Sidecar Development Guide

If you're reading this document then you've decided to contribute to the Sidecar for Apache Cassandra.

## Building

./gradlew build

Packages can be built using the following Gradle commands:

./gradlew buildDeb
./gradlew buildRpm


## Testing

Our official CI for this project is CircleCI.

We strive for high quality, thoroughly tested code.

## Issue Tracker

File bugs or look for issues to work on in our project JIRA: https://issues.apache.org/jira/browse/CASSANDRASC

## Submitting Patches

You may open a PR against our project: http://github.com/apache/cassandra-sidecar

Please link to the PR from the JIRA ticket. All work *must* have a corresponding JIRA ticket. Please put the JIRA ID in the body of the pull request.

@@ -0,0 +1,15 @@
# Overview

This is the documentation for the official Sidecar project for Apache Cassandra.

NOTE: This documentation is only a placeholder at the moment and requires some love.

## Installation

You will probably find it easiest to install the sidecar by using one of the system packages we have available.

## Setup

If you've installed the sidecar via a DEB or RPM package you will be able to use systemd to start, stop etc.


@@ -0,0 +1,4 @@
rootProject.name = "cassandra-sidecar"

include "docs"

0 comments on commit d57f2a4

Please sign in to comment.