How to see installed plugin documentation?

stef97 · October 22, 2018, 2:16pm

Hi,

How can one see the documentation of a plugin that was installed using rpm?
For example, I installed wreckingball ( including wreckingball-doc), there are 2 directories ( ri and rdoc with files in them) so I am assuming there should be a way to read the docs

Here is an excerpt
tree /opt/theforeman/tfm/root/usr/share/gems/doc/foreman_wreckingball-3.0.0
/opt/theforeman/tfm/root/usr/share/gems/doc/foreman_wreckingball-3.0.0
├── rdoc
│ ├── css
│ │ ├── fonts.css
│ │ └── rdoc.css
│ ├── fonts
│ │ ├── Lato-LightItalic.ttf
│ │ ├── Lato-Light.ttf
│ │ ├── Lato-RegularItalic.ttf
│ │ ├── Lato-Regular.ttf
│ │ ├── SourceCodePro-Bold.ttf
│ │ └── SourceCodePro-Regular.ttf
│ ├── Foreman.html
│ ├── ForemanWreckingball

paulcalabro · October 22, 2018, 2:37pm

RDoc produces HTML documentation. You should be able to open Foreman.html with a web browser and view the docs. Does that not work?

stef97 · October 22, 2018, 2:52pm

Hi Paul,

No, it does not work

Just to clarify, clicking on “documentation” link provided by foreman is just listing generic documentation
and
https://myserver/foreman.html page does not exist

What am I missing / doing wrong ?
What exactly is a valid URL for seeing installed plugin documentation ?

Thanks

paulcalabro · October 22, 2018, 2:56pm

Sorry Steven, not sure about that one.

paulcalabro · October 22, 2018, 3:01pm

From what I can tell, there is limited documentation from that plugin:

github.com

dm-drogeriemarkt/foreman_wreckingball/blob/c595135250178232189df40a481f23b0aafbd3b8/Rakefile#L20


require 'rdoc/rdoc'
require 'rake/rdoctask'
RDoc::Task = Rake::RDocTask
end


RDoc::Task.new(:rdoc) do |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.title    = 'ForemanWreckingball'
rdoc.options << '--line-numbers'
rdoc.rdoc_files.include('README.rdoc')
rdoc.rdoc_files.include('lib/**/*.rb')
end


APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)


Bundler::GemHelper.install_tasks


require 'rake/testtask'


Rake::TestTask.new(:test) do |t|
t.libs << 'lib'

So basically documentation is created for this file:

github.com

dm-drogeriemarkt/foreman_wreckingball/blob/master/README.md

# ForemanWreckingball

This is a plugin for Foreman that adds several VMware related status checks to your Hosts in Foreman. For performance reasons, these checks are only run periodically.

## Compatibility

| Foreman Version | Plugin Version |
| --------------- | -------------- |
| >= 1.15         | ~> 0.1         |
| >= 1.16         | ~> 1.0         |
| >= 1.17         | ~> 2.0         |
| >= 1.18         | ~> 3.0         |

## Installation

See [Plugins install instructions](https://theforeman.org/plugins/)
for how to install Foreman plugins.
You need to install the package `tfm-rubygem-foreman_wreckingball`.

## Contributing

This file has been truncated. show original

and all of these Ruby files:

https://github.com/dm-drogeriemarkt/foreman_wreckingball/tree/c595135250178232189df40a481f23b0aafbd3b8/lib (I suspect these just show the code)

stef97 · October 22, 2018, 3:12pm

Hi Paul,

Thanks for taking the trouble to dig a bit into this

Assuming I just picked the wrong plugin as an example for my issue, are you saying that a better documented plugin will have its documentation available at https://server/foreman.html ?

Thanks
Steven