prometheus-fastapi-instrumentator icon indicating copy to clipboard operation
prometheus-fastapi-instrumentator copied to clipboard

Published 20 hours ago • verified publisher icon trallnag

The docs links show 404

Open Idimmusix opened this issue 2 years ago • 6 comments
trafficstars

The links to the github pages containing the docs show a 404.

Idimmusix avatar Dec 08 '22 02:12 Idimmusix

+1, please fix it

rustam-python avatar Jan 17 '23 14:01 rustam-python

+1 Please fix.

djordan-ri avatar Jul 21 '23 15:07 djordan-ri

The page does not exist anymore. What are you struggeling with? Also I have removed the links now.

trallnag avatar Jul 21 '23 18:07 trallnag

@trallnag I don't have a particular issue, but it's frustrating when you're trying to develop, docs are linked, and then they're dead. Are I see in your commit that you've removed the links now. Are there any plans to re-document, or provide other usage examples :) ?

djordan-ri avatar Jul 24 '23 15:07 djordan-ri

@djordan-ri, nope. The formerly existing documation was merely automatically generated from the source code and comments. And some point I removed this because one can just look directly at the code in GitHub.

I've collected some examples here: https://github.com/trallnag/prometheus-fastapi-instrumentator/tree/master/devel/examples

trallnag avatar Jul 24 '23 16:07 trallnag

Right. Understood. In that case, it might resolve the issue to link those examples in the top-level README. I hadn't found those exemplars, and I think most would be surprised to find them under devel/

djordan-ri avatar Jul 25 '23 08:07 djordan-ri