-
Notifications
You must be signed in to change notification settings - Fork 205
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
documentation views analytics for crate maintaners #472
Comments
Thanks for reaching out! At the moment we don't collect access logs for documentation views, so we're unable to provide you with the data. Anonymized access stats for crate authors would be good to have though, so that's something we could consider in the future. |
Hey, thanks for your swift reply - appreciate you are busy with normal maintenance. Glad to hear this is useful and I think many other library developers will appreciate such analytics. What's the best way for me to start a conversation about this and get more opinions/thoughts/suggestions from other library developers? I feel that an RFC is too heavy duty for this, so keen to hear your advice on the best format. I'm curious - does your web server not have any logging of GET requests that we could grep "tantivy" over to get a tough idea? |
I'm looking over this now, and it seems we do have some logs in /var/log/nginx we could grep for. Note that these logs are not accurate because we cache using cloudfront, but they might be enough for a rough estimate. I think @pietroalbini might have meant that we don't track accesses in the application, so this only happens to work in production, and won't be reproducible anywhere else (e.g. if we wanted to show it on the website). With that said, here are the logs of pages with more than one visit (showing only the URLs without metadata): logs
|
Hey @jyn514 - thanks for providing this. Should be helpful in tackling most important/least documented pages. Is there any scope to extend this log summaries in the future, so maintainers can keep improving documentation using this information? |
It would be a fairly large time and storage investment (where would we store the logs?). I would be willing to take a PR adding this, but I don't plan to add it myself any time soon. |
Small update here: since we cache in the CDN now, this tracking would either have to be JS, or based on the CDN logs. |
hey,
Thanks for building and maintaining such a great documentation resource. I am one of the contributors to tantivy - a library for building custom search applications.
I was wondering if you collect and would be able to share (privately, if you prefer) analytics for views of specific pages on docs.rs/tantivy.
Since we are building a library, not an application, our main method of helping our users is through examples, good code and documentation.
There are many types, traits and enums in our library and we would like to prioritise our effort to document them (ideally we would like to document all of them, but it's hard).
I think it will be useful to see the top 50 most visited pages on docs.rs/tantivy so we can spend time documenting the most sought-after items.
I appreciate the privacy concerns (entirely valid) and would only request anonymised, aggregated data for only docs.rs/tantivy.
Thanks again for all your great work on this!
The text was updated successfully, but these errors were encountered: