Skip to content

Commit

Permalink
Combine developer documentation and user documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
basil committed Feb 24, 2021
1 parent 1cdd333 commit 18b074e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 27 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
# Jenkins Resource Disposer Plugin

[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/resource-disposer.svg?color=blue)](https://plugins.jenkins.io/resource-disposer)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/resource-disposer.svg?color=blue)](https://plugins.jenkins.io/resource-disposer)

![](/docs/images/resource-disposer.png)

Resource Disposer is a utility plugin for other plugins to depend on.
Resources that are no longer needed (VMs to delete, entries in other
systems, etc.) are registered in the plugin that attempts to delete it
repeatedly. Failures to do so will be reported in the form of
administrative monitor and can be examined at
`JENKINS_URL/administrativeMonitor/AsyncResourceDisposer/`. Such entries
are persisted between restarts and tracked until the plugin that has
contributed them either succeeds in disposing them or they get removed
some other way (ex: Administrator removes them manually). Provided the
problem preventing the disposal persists, instance administrators are
expected to resolve that based on administrative monitor reports.

# Integrating Resource Disposer into plugin

## Overview
Expand Down Expand Up @@ -25,9 +44,3 @@ a way to report successful deletion in case the resource disappears.
in a way to still be able to perform its task. In case the resource is freed by
Jenkins restart naturally, it should deserialize into an object to report success
all the time (to be unregistered on first periodic attempt to dispose).

# Further Information
See [user documentation and more](https://plugins.jenkins.io/resource-disposer/) on the Jenkins Plugin Site.

[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/resource-disposer.svg?color=blue)](https://plugins.jenkins.io/resource-disposer)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/resource-disposer.svg?color=blue)](https://plugins.jenkins.io/resource-disposer)
21 changes: 0 additions & 21 deletions docs/README.md

This file was deleted.

0 comments on commit 18b074e

Please sign in to comment.