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.

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

Publish-IcingaPluginDocumentation is clearing entire docs on creation #32

Closed
LordHepipud opened this issue Jul 24, 2020 · 0 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@LordHepipud
Copy link
Collaborator

By using Publish-IcingaPluginDocumentation we automatically generate the documentation for each plugin for GitHub/Icinga.com.

How ever, right now we are flushing the entire folder content and re-creating each single file with a new index, making it incompatible with possible old links to docs. For example if we are having the plugin doc file 01-Invoke-IcingaCheckBiosSerial.md and create a new plugin like Invoke-IcingaCheckAsSomething this one would be moved to index 1, while the Bios plugin be moved to Index 2.

This makes it hard to keep track on docs and links as the entire doc structure is regulary changing. We should check if a plugin doc file already exist and update that one and only create new files for new check commands with a new index if neccessary.

@LordHepipud LordHepipud added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 24, 2020
@LordHepipud LordHepipud added this to the v.1.2.0 milestone Jul 24, 2020
@LordHepipud LordHepipud self-assigned this Jul 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant