[PATCH] Documented opensourcing of the OTel module

[Maxim Dounin]

Hello!

On Tue, Jan 23, 2024 at 01:49:07PM +0000, Yaroslav Zhuravlev wrote:

>  xml/en/docs/index.xml           |   8 +++++++-
>  xml/en/docs/ngx_otel_module.xml |  20 +++++++++++++++-----
>  xml/ru/docs/index.xml           |  10 ++++++++--
>  3 files changed, 30 insertions(+), 8 deletions(-)
> 
> 

> # HG changeset patch
> # User Yaroslav Zhuravlev <yar at nginx.com>
> # Date 1704815768 0
> #      Tue Jan 09 15:56:08 2024 +0000
> # Node ID 00807e94be3622a79d7796be6ea11934f97b2662
> # Parent  e3116677300fa455200da63002c746aece689029
> Documented opensourcing of the OTel module.
> 
> diff --git a/xml/en/docs/index.xml b/xml/en/docs/index.xml
> --- a/xml/en/docs/index.xml
> +++ b/xml/en/docs/index.xml
> @@ -8,7 +8,7 @@
>  <article name="nginx documentation"
>           link="/en/docs/"
>           lang="en"
> -         rev="49"
> +         rev="50"
>           toc="no">
>  
>  
> @@ -681,6 +681,12 @@
>  ngx_mgmt_module</link>
>  </listitem>
>  
> +</list>
> +</para>
> +
> +<para>
> +<list type="bullet">
> +
>  <listitem>
>  <link doc="ngx_otel_module.xml">
>  ngx_otel_module</link>
> diff --git a/xml/en/docs/ngx_otel_module.xml b/xml/en/docs/ngx_otel_module.xml
> --- a/xml/en/docs/ngx_otel_module.xml
> +++ b/xml/en/docs/ngx_otel_module.xml
> @@ -9,12 +9,14 @@
>  <module name="Module ngx_otel_module"
>          link="/en/docs/ngx_otel_module.html"
>          lang="en"
> -        rev="1">
> +        rev="2">
>  
>  <section id="summary">
>  
>  <para>
> -The <literal>ngx_otel_module</literal> module (1.23.4) provides
> +The <literal>ngx_otel_module</literal> module (1.23.4) is nginx-authored

Quoting from 
https://mailman.nginx.org/pipermail/nginx-devel/2023-October/4AGH5XVKNP6UDFE32PZIXYO7JQ4RE37P.html:

: Note that "nginx-authored" here looks misleading, as no nginx core 
: developers work on this module.

> +<link url="https://github.com/nginxinc/nginx-otel">third-party module</link>
> +that provides
>  <link url="https://opentelemetry.io">OpenTelemetry</link>
>  distributed tracing support.
>  The module supports
> @@ -23,12 +25,20 @@
>  </para>
>  
>  <para>
> +The module is open source since 1.25.2.
> +Download and install instructions are available
> +<link url="https://github.com/nginxinc/nginx-otel/blob/main/README.md">here</link>.
> +The module is also available as a prebuilt
> +<literal>nginx-module-otel</literal> dynamic module
> +<link doc="../linux_packages.xml" id="dynmodules">package</link> (1.25.4).
> +</para>
> +
> +<para>
>  <note>
>  This module is available as part of our
>  <commercial_version>commercial subscription</commercial_version>
> -in <literal>nginx-plus-module-otel</literal> package.
> -After installation, the module can be loaded
> -<link doc="ngx_core_module.xml" id="load_module">dynamically</link>.
> +(the
> +<link url="https://docs.nginx.com/nginx/admin-guide/dynamic-modules/opentelemetry"><literal>nginx-plus-module-otel</literal></link> package).

I don't see reasons to provide additional links here.  Rather, the 
note probably can be removed altogether, or changed to something 
like "In previuos versions, this module is available...".

>  </note>
>  </para>
>  
> diff --git a/xml/ru/docs/index.xml b/xml/ru/docs/index.xml
> --- a/xml/ru/docs/index.xml
> +++ b/xml/ru/docs/index.xml
> @@ -8,7 +8,7 @@
>  <article name="nginx: документация"
>           link="/ru/docs/"
>           lang="ru"
> -         rev="49"
> +         rev="50"
>           toc="no">
>  
>  
> @@ -687,9 +687,15 @@
>  ngx_mgmt_module</link> [en]
>  </listitem>
>  
> +</list>
> +</para>
> +
> +<para>
> +<list type="bullet">
> +
>  <listitem>
>  <link doc="ngx_otel_module.xml">
> -ngx_otel_module [en]</link>
> +ngx_otel_module</link> [en]
>  </listitem>
>  
>  </list>

> _______________________________________________
> nginx-devel mailing list
> nginx-devel at nginx.org
> https://mailman.nginx.org/mailman/listinfo/nginx-devel


-- 
Maxim Dounin
http://mdounin.ru/