Package tendrl-api-doc is not useful for tendrl admin

[mbukatov]

Package with api documentation tendrl-api-doc contains files which are already packaged somewhere else without explanation which would be helpful in rpm installed product context.

This unfortunately means that the doc package provides no value for the user in it's current form.

Details of the problem

# rpm -ql tendrl-api-doc
/usr/share/doc/tendrl/README.adoc
/usr/share/doc/tendrl/Rakefile
/usr/share/doc/tendrl/config
/usr/share/doc/tendrl/config/apache.vhost.sample
/usr/share/doc/tendrl/config/etcd.sample.yml
/usr/share/doc/tendrl/config/tendrl.sample.yml

Rakefile is the same as in tendrl-api package (what is the purpose of this?):

# diff /usr/share/tendrl-api/Rakefile /usr/share/doc/tendrl/Rakefile
#

File etcd.sample.yml the same as default configuration of tendrl-api:

# diff /etc/tendrl/etcd.yml /usr/share/doc/tendrl/config/etcd.sample.yml
#

The same holds for apache configuration shipped in tendrl-api-httpd:

# diff /usr/share/doc/tendrl/config/apache.vhost.sample /etc/httpd/conf.d/tendrl.conf
#

And last but not least, the purpose of tendrl.sample.yml is unknown when someone opens it for the first time.

Which brings me the the main problem here: the readme file packaged there is the readme file from the tendrl-api git repository and it doesn't provide any explanation what the example config files are for, and most of the information are not suitable for installation from rpm packages.

Version

tendrl-api-1.4.2-1.el7.centos.noarch tendrl-api-doc-1.4.2-1.el7.centos.noarch

Additional information

I'm not against shipping example configuration files or readme, but to make this package useful, we would need to think over what is the purpose of each sample file and write that down into a readme file - or to drop the docs package completely.

[r0h4n]

@anivargi please respond to this

[TimothyAsirJeyasing]

The main intention of this package into TENDRL is to provide a sample documentation about how to use and the useful configurations. As of now we dont have any examples or any specific configuration for fine tuning. If it's really not required or might not useful in feature enhancements we can remove this package. @anivargi Please share your views.

[anivargi]

We don't have any specific doc that can be part of tendrl-api-doc, we can add this when we have proper useful documentation in the future.

[mbukatov]

@anivargi does this mean that we are going to drop tendrl-api-doc package until we have something interesting to put there? I'm asking because in the last snapshot build I still see the doc package.

[TimothyAsirJeyasing]

You can close this issue because its already addressed and reopen if you still find any.