From 7b8c7720477dafc5c539533c683d950b6450ada4 Mon Sep 17 00:00:00 2001 From: "R. Tyler Croy" Date: Fri, 15 Nov 2019 19:31:52 -0800 Subject: [PATCH] Rename all the asciidoc documents to .adoc and re-create the README --- doc/index.ad => README.adoc | 34 ++++------- doc/{auth.ad => auth.adoc} | 0 doc/{config.ad => config.adoc} | 0 doc/{hacking.ad => hacking.adoc} | 0 doc/{internals.ad => internals.adoc} | 0 doc/models/{artifact.ad => artifact.adoc} | 0 doc/running.ad | 72 ----------------------- doc/{webui.ad => webui.adoc} | 0 doc/{workflow.ad => workflow.adoc} | 0 9 files changed, 10 insertions(+), 96 deletions(-) rename doc/index.ad => README.adoc (86%) rename doc/{auth.ad => auth.adoc} (100%) rename doc/{config.ad => config.adoc} (100%) rename doc/{hacking.ad => hacking.adoc} (100%) rename doc/{internals.ad => internals.adoc} (100%) rename doc/models/{artifact.ad => artifact.adoc} (100%) delete mode 100644 doc/running.ad rename doc/{webui.ad => webui.adoc} (100%) rename doc/{workflow.ad => workflow.adoc} (100%) diff --git a/doc/index.ad b/README.adoc similarity index 86% rename from doc/index.ad rename to README.adoc index 212ee79..546a32c 100644 --- a/doc/index.ad +++ b/README.adoc @@ -1,30 +1,7 @@ -= #DeployDB - -image::https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/lookout/deploydb"] -image:https://travis-ci.org/lookout/deploydb.svg?branch=master["Build Status", link="https://travis-ci.org/lookout/deploydb"] += DeployDB **Who, what, where and when.** ---- - -== Important Links - -* link:https://github.com/lookout/deploydb[Source code] -* link:https://github.com/lookout/deploydb/issues[Issue Tracker] -* link:https://bintray.com/lookout/systems/DeployDB/_latestVersion[Latest released version] - -=== Internals/Hacking - -* <> -* link:restapi/index.html[REST API documentation] -* link:groovydoc/index.html[Groovydocs] -* <> -* <> -* <> -* <> -* <> - - == The Problem As a service-oriented infrastructure grows, testing and managing/driving @@ -34,6 +11,15 @@ Tracking versions of application and configuration management code through a consistent pipeline of tiered environments where verification of those changes can occur is difficult. +=== Internals/Hacking + +* <> +* <> +* <> +* <> +* <> +* <> + == The Solution DeployDB is a tool to provide a single source of truth for artifact-based diff --git a/doc/auth.ad b/doc/auth.adoc similarity index 100% rename from doc/auth.ad rename to doc/auth.adoc diff --git a/doc/config.ad b/doc/config.adoc similarity index 100% rename from doc/config.ad rename to doc/config.adoc diff --git a/doc/hacking.ad b/doc/hacking.adoc similarity index 100% rename from doc/hacking.ad rename to doc/hacking.adoc diff --git a/doc/internals.ad b/doc/internals.adoc similarity index 100% rename from doc/internals.ad rename to doc/internals.adoc diff --git a/doc/models/artifact.ad b/doc/models/artifact.adoc similarity index 100% rename from doc/models/artifact.ad rename to doc/models/artifact.adoc diff --git a/doc/running.ad b/doc/running.ad deleted file mode 100644 index 65abfe6..0000000 --- a/doc/running.ad +++ /dev/null @@ -1,72 +0,0 @@ -== Running the deploydb from bintray - -* Download the deploydb-*tar from bintray -* Uncompress the tar file - -* Create deploydb model configuration. Check the following directory link for configuration template -files for the deploydb models. -Make sure all the model configuration files are *_stored in a single_* directory ----- -https://github.com/lookout/deploydb/tree/master/example/modelConfig ----- - -* Create deploydb application configuration. Check the following link for template of this -configuration ----- -https://github.com/lookout/deploydb/blob/master/example/deploydb.launch.yml ----- - -* Update the model configuration directory parameter in the application configuration ----- -configDirectory: ----- - -* Setup the database before starting the deploydb. Use the created application configuration from the -above section ----- -./bin/deploydb db migrate .yml ----- - -* Start the deploydb using following command ----- -./bin/deploydb server .yml ----- - -=== Running the deploydb from github repo - -To run the application on localhost run the following commands. - -* Package the deploydb from source using following command - ----- - gradlew shadowJar ----- - -* Setup the database using following command. Default database is H2 and db file is stored in -current directory as deploydb.example.db. - ----- - java -jar build/libs/deploydb-*-all.jar db migrate example/deploydb.launch.yml ----- - -* Run the deploydb using following command. The last argument of the command below is the application -configuration file of the deploydb. Please check and update this file as required. An example model -configuration for webhooks, service and environment etc is present in example/modelConfig directory. -Change the content of these model configuration files to the required values. - ----- - java -jar build/libs/deploydb-*-all.jar server example/deploydb.launch.yml ----- - -* To create artifact (That triggers deployment create) - ----- - curl -X POST -H "Content-Type: application/json" http://localhost:8080/api/artifacts -d '{"group" : "basic.group.1", "name": "bg1", "version" : "1.2.3.4", "sourceUrl" : "http://example.com/cucumber.jar"}' ----- - -* To get all deployments - ----- - curl -X GET http://localhost:8080/api/deployments ----- - diff --git a/doc/webui.ad b/doc/webui.adoc similarity index 100% rename from doc/webui.ad rename to doc/webui.adoc diff --git a/doc/workflow.ad b/doc/workflow.adoc similarity index 100% rename from doc/workflow.ad rename to doc/workflow.adoc