Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make documentation compatible with Ansible Galaxy #321

Open
30 of 43 tasks
Donien opened this issue Aug 16, 2024 · 1 comment
Open
30 of 43 tasks

Make documentation compatible with Ansible Galaxy #321

Donien opened this issue Aug 16, 2024 · 1 comment
Assignees
@Donien
Labels
docs Improvements or additions to documentation
Milestone
v0.4.0

Comments

@Donien
Copy link
Collaborator

Donien commented Aug 16, 2024 •
edited
Loading

To be able to display the Collection's documentation on Ansible Galaxy (and by proxy by using ansible-doc) we should change the location of certain pieces of documentation, merge and add some files.

Even though most of the modules and plugins within this Collection are meant for internal use, ansible-doc still finds them but can't show any documentation.
We should at least add a basic description.

  • Collection README
    • Avoid links or use absolute ones since Galaxy can't seem to handle relative ones
  • Roles README
    • icinga2
    • icingadb
    • icingadb_redis
    • icingaweb2
    • monitoring_plugins
    • repos
  • Modules / Plugins
    • icinga2_apilistener
    • icinga2_apiuser
    • icinga2_checkcommand
    • icinga2_checkercomponent
    • icinga2_dependency
    • icinga2_elasticsearchwriter
    • icinga2_endpoint
    • icinga2_eventcommand
    • icinga2_externalcommandlistener
    • icinga2_filelogger
    • icinga2_gelfwriter
    • icinga2_graphitewriter
    • icinga2_host
    • icinga2_hostgroup
    • icinga2_icingaapplication
    • icinga2_icingadb
    • icinga2_idomysqlconnection
    • icinga2_idopgsqlconnection
    • icinga2_influxdb2writer
    • icinga2_influxdbwriter
    • icinga2_livestatuslistener
    • icinga2_notification
    • icinga2_notificationcommand
    • icinga2_notificationcomponent
    • icinga2_opentsdbwriter
    • icinga2_perfdatawriter
    • icinga2_scheduleddowntime
    • icinga2_service
    • icinga2_servicegroup
    • icinga2_sysloglogger
    • icinga2_timeperiod
    • icinga2_user
    • icinga2_usergroup
    • icinga2_zone

Ref:
@Donien Donien added the docs Improvements or additions to documentation label Aug 16, 2024
@Donien
Copy link
Collaborator Author

Donien commented Aug 30, 2024

Some progress:
main...doc/321-ansible-galaxy

@Donien Donien self-assigned this Nov 15, 2024
@Donien Donien added this to the v0.4.0 milestone Nov 15, 2024
@Donien Donien mentioned this issue Nov 15, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Donien Donien

Labels
docs Improvements or additions to documentation
Projects
None yet
Milestone
v0.4.0
Development

No branches or pull requests
1 participant
@Donien