uptime-kuma-wiki
uptime-kuma-wiki copied to clipboard
louislam
Document Monitors
⚠️ Please verify that this feature request has NOT been suggested before.
- [X] I checked and didn't find similar feature request
🏷️ Feature Request Type
Other
🔖 Feature description
Document each monitor and how it functions as well as it's configuration settings.
✔️ Solution
Crowd source the documentation process.
❓ Alternatives
Do nothing.
📝 Additional Context
The documentation could be improved overall.
@jordantrizz I am assuming this has improved a lot in the last year. Our wiki is at https://github.com/louislam/uptime-kuma/wiki
Given that this issue does not have any concrete complains, I am going to close it as resolved. If you have concrete suggestions what monitors are documented badly in our UI, please feel free to reach out ^^
@CommanderStorm I wouldn't know as I haven't visited the wiki for over a year. I still don't see a section listing all the monitors and their configuration options, unless I'm blind.
Indeed, I copied the wrong link for this issue. We currently have a guide for the docker monitor (as this is more difficult to set up, all other monitors should be self explainatory).
There is still not enough information in this issue to go on:
- Which monitor would you need documentation on?
- Which one is not already sufficiently documented/clear in the frontend?
I'd see it as best practice to document all the monitors and provide information on their operation and any caveats. It could save someone from searching for issues, putting in an issue and responding to problems with the monitor's documentation.
Just food for thought; I don't care anymore. I just found the uptimekuma documentation thin compared to other projects.