From ac524698d29672a0b8d680ddc8b44eeafab2e482 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Mon, 27 Jan 2020 13:41:29 +0100 Subject: [PATCH] update docs and readme --- .drone.jsonnet | 7 ------- .drone.yml | 8 +------- README.md | 18 +++++++++--------- docs/content/_index.md | 17 ++++++++--------- 4 files changed, 18 insertions(+), 32 deletions(-) diff --git a/.drone.jsonnet b/.drone.jsonnet index bf6f61c..2340878 100644 --- a/.drone.jsonnet +++ b/.drone.jsonnet @@ -309,13 +309,6 @@ local PipelineNotifications = { SHORT_DESCRIPTION: 'ansible-doctor - Simple annotation based documentation for your roles', }, }, - { - name: 'microbadger', - image: 'plugins/webhook', - settings: { - urls: { from_secret: 'microbadger_url' }, - }, - }, { name: 'matrix', image: 'plugins/matrix', diff --git a/.drone.yml b/.drone.yml index 44fc6d2..955cfa5 100644 --- a/.drone.yml +++ b/.drone.yml @@ -432,12 +432,6 @@ steps: README_PATH: README.md SHORT_DESCRIPTION: ansible-doctor - Simple annotation based documentation for your roles -- name: microbadger - image: plugins/webhook - settings: - urls: - from_secret: microbadger_url - - name: matrix image: plugins/matrix settings: @@ -464,6 +458,6 @@ depends_on: --- kind: signature -hmac: effd4a9b4d0a8672e91c75931a015e4ae4d343678d408c5061f9009b00d859ae +hmac: 6d5718adf1ec8045c4b90e1ded1a5286af4c8721302aa8be4f157078bf7e67a3 ... diff --git a/README.md b/README.md index 62afcbb..29dc7e2 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # ansible-doctor -[![Build Status](https://cloud.drone.io/api/badges/xoxys/ansible-doctor/status.svg)](https://cloud.drone.io/xoxys/ansible-doctor) -[![](https://images.microbadger.com/badges/image/xoxys/ansible-doctor.svg)](https://microbadger.com/images/xoxys/ansible-doctor "Get your own image badge on microbadger.com") -[![](https://img.shields.io/pypi/pyversions/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) -[![](https://img.shields.io/pypi/status/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) -[![](https://img.shields.io/pypi/v/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) -![License](https://img.shields.io/github/license/xoxys/ansible-doctor) +[![Build Status](https://img.shields.io/drone/build/xoxys/ansible-doctor?logo=drone)](https://cloud.drone.io/xoxys/ansible-doctor) +[![Docker Hub](https://img.shields.io/badge/docker-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/xoxys/ansible-doctor) +[![Python Version](https://img.shields.io/pypi/pyversions/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) +[![PyPi Status](https://img.shields.io/pypi/status/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) +[![PyPi Release](https://img.shields.io/pypi/v/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](LICENSE) This project is based on the idea (and at some parts on the code) of [ansible-autodoc](https://github.com/AndresBott/ansible-autodoc) by Andres Bott so credits goes to him for his work. -*ansible-doctor* is a simple annotation like documentation generator based on Jinja2 templates. While *ansible-doctor* comes with a default template called `readme`, it is also possible to write your own templates. This gives you the ability to customize the output and render the data to every format you like (e.g. html or xml). +_ansible-doctor_ is a simple annotation like documentation generator based on Jinja2 templates. While _ansible-doctor_ comes with a default template called `readme`, it is also possible to write your own templates. This gives you the ability to customize the output and render the data to every format you like (e.g. html or xml). -*ansible-doctor* is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages on [GitHub](https://github.com/xoxys/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image on [DockerHub](https://hub.docker.com/r/xoxys/ansible-doctor). +_ansible-doctor_ is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages on [GitHub](https://github.com/xoxys/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image on [DockerHub](https://hub.docker.com/r/xoxys/ansible-doctor). -You can find the full documentation at [ansible-doctor.geekdocs.de](https://ansible-doctor.geekdocs.de/). +You can find the full documentation at [https://ansible-doctor.geekdocs.de](https://ansible-doctor.geekdocs.de/). ### License diff --git a/docs/content/_index.md b/docs/content/_index.md index 296812c..5828c6e 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -2,16 +2,15 @@ title: Documentation --- -[![Build Status](https://cloud.drone.io/api/badges/xoxys/ansible-doctor/status.svg)](https://cloud.drone.io/xoxys/ansible-doctor) -[![](https://img.shields.io/pypi/pyversions/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) -[![](https://img.shields.io/pypi/status/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) -[![](https://img.shields.io/pypi/v/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) -[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) +[![Build Status](https://img.shields.io/drone/build/xoxys/ansible-doctor?logo=drone)](https://cloud.drone.io/xoxys/ansible-doctor/) +[![Docker Hub](https://img.shields.io/badge/docker-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/xoxys/ansible-doctor/) +[![Python Version](https://img.shields.io/pypi/pyversions/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) +[![PyPi Status](https://img.shields.io/pypi/status/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) +[![PyPi Release](https://img.shields.io/pypi/v/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](LICENSE) This project is based on the idea (and at some parts on the code) of [ansible-autodoc](https://github.com/AndresBott/ansible-autodoc) by Andres Bott so credits goes to him for his work. -*ansible-doctor* is a simple annotation like documentation generator based on Jinja2 templates. While *ansible-doctor* comes with a default template called `readme`, it is also possible to write your own templates. This gives you the ability to customize the output and render the data to every format you like (e.g. html or xml). +_ansible-doctor_ is a simple annotation like documentation generator based on Jinja2 templates. While _ansible-doctor_ comes with a default template called `readme`, it is also possible to write your own templates. This gives you the ability to customize the output and render the data to every format you like (e.g. html or xml). -*ansible-doctor* is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages at [GitHub](https://github.com/xoxys/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image at [DockerHub](https://hub.docker.com/r/xoxys/ansible-doctor). - -You can find the full documentation at [ansible-doctor.geekdocs.de](https://ansible-doctor.geekdocs.de). +_ansible-doctor_ is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages at [GitHub](https://github.com/xoxys/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image at [DockerHub](https://hub.docker.com/r/xoxys/ansible-doctor).