Re: Simple analytics for docs.kernel.org and patchwork, please?

Re: Simple analytics for docs.kernel.org and patchwork, please?

[Jakub Kicinski]

On Mon, 26 Feb 2024 14:24:39 -0500 Konstantin Ryabitsev wrote:
> In general, my previous experience enabling libravatar on git.kernel.org has
> taught me that many very vocal people *really* don't like to have any kind of
> statistics gathered about them. However, if it's just for docs.kernel.org,
> then I don't think I have specific objections.
> 
> That said, I would need help turning this on -- if someone can pass me along a
> Sphinx configuration option that I can enable during build time, then I'll be
> happy to add it to our build jobs.

Excellent :)

Let me CC linux-doc in case someone can tell us how to hook things in.

Could you give me a ballpark number of page hits for docs.kernel.org?
500k page views a month should be enough? Plausible has different
pricing depending on number of views, I need to know how much money
to ask for.

Re: Simple analytics for docs.kernel.org and patchwork, please?

[Jonathan Corbet]

Jakub Kicinski <kuba@kernel.org> writes:

> On Mon, 26 Feb 2024 14:24:39 -0500 Konstantin Ryabitsev wrote:
>> In general, my previous experience enabling libravatar on git.kernel.org has
>> taught me that many very vocal people *really* don't like to have any kind of
>> statistics gathered about them. However, if it's just for docs.kernel.org,
>> then I don't think I have specific objections.
>> 
>> That said, I would need help turning this on -- if someone can pass me along a
>> Sphinx configuration option that I can enable during build time, then I'll be
>> happy to add it to our build jobs.
>
> Excellent :)
>
> Let me CC linux-doc in case someone can tell us how to hook things in.

It's probably not just a configuration option.  I suspect that this will
need to be done either by editing the templates or with a little
extension.  Either could require adding this support to the kernel repo,
which might raise some eyebrows.

jon

Re: Simple analytics for docs.kernel.org and patchwork, please?

[Jakub Kicinski]

On Mon, 26 Feb 2024 12:58:43 -0700 Jonathan Corbet wrote:
> Jakub Kicinski <kuba@kernel.org> writes:
> > On Mon, 26 Feb 2024 14:24:39 -0500 Konstantin Ryabitsev wrote:  
> >> In general, my previous experience enabling libravatar on git.kernel.org has
> >> taught me that many very vocal people *really* don't like to have any kind of
> >> statistics gathered about them. However, if it's just for docs.kernel.org,
> >> then I don't think I have specific objections.
> >> 
> >> That said, I would need help turning this on -- if someone can pass me along a
> >> Sphinx configuration option that I can enable during build time, then I'll be
> >> happy to add it to our build jobs.  
> >
> > Excellent :)
> >
> > Let me CC linux-doc in case someone can tell us how to hook things in.  
> 
> It's probably not just a configuration option.  I suspect that this will
> need to be done either by editing the templates or with a little
> extension.  Either could require adding this support to the kernel repo,
> which might raise some eyebrows.

FWIW I tried poking around to insert "script_files" into conf.py,
because the RTD template does seem to have:

      {%- for scriptfile in script_files %}
        {{ js_tag(scriptfile) }}
      {%- endfor %}

But I only managed to add a pure "include" with just the 'src'
attribute on the <script> node, like:

	<script src="../../cabbage.js"></script>

We also need to set 'defer' and "data-domain="docs.kernel.org"'.